Creating a .env.go.local file is a common practice for Go developers, especially when working on projects that require environment-specific configurations. This file typically contains local environment variables that are not committed to version control, keeping sensitive information like API keys, database credentials, and other secrets secure.
init-dev: cp .env .env.go.local.example @echo "Created .env.go.local.example – copy to .env.go.local and edit"
: This file is almost always added to .gitignore . It is meant to exist only on your physical machine and never be committed to a version control system. Usage Comparison .env Default variables for all environments. .env.go Go-specific defaults for the team. .env.go.local No Your personal overrides for local Go development.
// Loads .env, then overrides with .env.go.local godotenv.Load(".env") godotenv.Overload(".env.go.local") Use code with caution. Alternative: Using envconfig for Structured Configs .env.go.local
Your team's shared .env file might point to a shared local Docker container:
# .env.go.local DB_HOST=localhost DB_USER=admin DB_PASSWORD=supersecretpassword API_KEY=local_debug_key PORT=8080 Use code with caution. Step 2: Update .gitignore
package main import ( "log" "os" "://github.com" ) func main() // Explicitly load the .env.go.local file err := godotenv.Load(".env.go.local") if err != nil log.Println("No .env.go.local file found, falling back to system environment") // Access the variables using the standard library port := os.Getenv("PORT") dbUser := os.Getenv("DB_USER") log.Printf("Server starting on port %s for user %s", port, dbUser) Use code with caution. Method B: Using ://github.com Creating a
Your Go initialization code should handle this gracefully by logging a warning—not crashing—if .env.go.local is missing in production environments, allowing the application to read the system environment variables seamlessly. If you want to implement this in your project, let me know:
As projects grow, managing multiple environment files—such as distinguishing between general local defaults and machine-specific secrets—becomes necessary. This is where the .env.go.local pattern becomes highly useful. Understanding the .env File Hierarchy
# .env PORT=8080 DB_DSN=postgres://user:pass@localhost:5432/mydb REDIS_ADDR=localhost:6379 LOG_LEVEL=info It is meant to exist only on your
// Access environment variables apiKey := os.Getenv("API_KEY") log.Println(apiKey)
Sensitive credentials (like your personal local API keys) should not be committed to Git. Using .env.go.local ensures your private keys stay on your machine. 3. Machine-Specific Overrides
To use a .env.go.local file in your Go project, follow these steps:
By naming it .env.go.local , developers know explicitly that this file is for local testing and configuration, not for production overrides.