golang-project-layout

The best way to structure a Golang project directory is to organize it based on project type and scope, enforcing clean architecture boundaries and 12-factor conventions. This ensures the layout stays idiomatic and maintainable without adding unnecessary layers for small tools.

To organize cmd, internal, and pkg folders, place minimal executable logic in cmd, keep proprietary business logic in internal, and use pkg for shared library code. This directory structure enforces clean architecture boundaries and maintains correct module boundaries for Go services.

You should use a Go workspace (go.work) when splitting multiple binaries and modules within a monorepo. This project layout decision helps manage module boundaries effectively, ensuring maintainable dependency injection and clean architecture across different shared codebases.

Yes, this Go project layout approach works for CLI tools and libraries by guiding the correct directory structure based on project type. It prevents common mistakes like over-layering small tools or placing business logic in cmd, ensuring the layout is appropriately sized for the problem.

To configure environment-based settings for a 12-factor Go application, co-locate tests and apply environment-based configuration within your directory structure. This reinforces 12-factor conventions, separating config from code for maintainable Go services and CLI tools.