A powerful CLI tool for managing, validating, and transforming environment variable files.

• 📝 Documentation Generation: Create example files and JSON schemas from .env files
• 🔍 Auditing: Find duplicate keys and missing variables across multiple files
• 🔄 Synchronization: Keep environment files in sync across different environments
• 🔐 Security: Encrypt/decrypt files with AES-256 and generate SHA256 hashes
• 🔀 Conversion: Convert between .env, JSON, and YAML formats
• ✅ Validation: Validate .env files against JSON schemas
• 🎨 Interactive: User-friendly prompts and PIN-based confirmations
• 📊 Reports: Generate comprehensive markdown reports with table of contents
• 🎯 Cross-platform: Works on Linux, macOS, and Windows

Using curl:

curl -sSL https://raw.githubusercontent.com/MayR-Labs/envdoc-go/main/install.sh | bash

Or using wget:

wget -qO- https://raw.githubusercontent.com/MayR-Labs/envdoc-go/main/install.sh | bash

# AMD64 wget https://github.com/MayR-Labs/envdoc-go/releases/latest/download/envdoc-linux-amd64 chmod +x envdoc-linux-amd64 sudo mv envdoc-linux-amd64 /usr/local/bin/envdoc # ARM64 wget https://github.com/MayR-Labs/envdoc-go/releases/latest/download/envdoc-linux-arm64 chmod +x envdoc-linux-arm64 sudo mv envdoc-linux-arm64 /usr/local/bin/envdoc

# Intel wget https://github.com/MayR-Labs/envdoc-go/releases/latest/download/envdoc-darwin-amd64 chmod +x envdoc-darwin-amd64 sudo mv envdoc-darwin-amd64 /usr/local/bin/envdoc # Apple Silicon (M1/M2/M3) wget https://github.com/MayR-Labs/envdoc-go/releases/latest/download/envdoc-darwin-arm64 chmod +x envdoc-darwin-arm64 sudo mv envdoc-darwin-arm64 /usr/local/bin/envdoc

Download the latest envdoc-windows-amd64.exe from the releases page and add it to your PATH.

git clone https://github.com/MayR-Labs/envdoc-go.git cd envdoc-go go build -o envdoc . sudo mv envdoc /usr/local/bin/

envdoc --version

# Create an example file from your .env envdoc create-example .env # Generate a JSON schema envdoc create-schema .env # Audit a single file envdoc audit .env # Compare multiple files envdoc compare .env .env.staging .env.production # Sync files envdoc sync .env .env.staging .env.production

envdoc create-example [file] [output]

Generates an example file with empty values based on keys in the source file.

Example Output:

DATABASE_HOST= DATABASE_PORT= DATABASE_NAME= DATABASE_USER= DATABASE_PASSWORD= API_KEY= API_SECRET= API_BASE_URL=

envdoc create-schema [file] [output]

Generates a JSON schema defining all environment variables.

Example Schema:

{ "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "DATABASE_HOST": { "type": "string", "description": "Database Configuration" }, "DATABASE_PORT": { "type": "string" }, "API_KEY": { "type": "string", "description": "API Configuration" } }, "required": [ "DATABASE_HOST", "DATABASE_PORT", "API_KEY" ] }

envdoc arrange [file]

Sorts and groups environment variables alphabetically with blank lines separating different prefixes.

Example Output:

APP_DEBUG=true APP_ENV=development APP_NAME=MyApp AWS_ACCESS_KEY_ID=key123 AWS_SECRET_ACCESS_KEY=secret456 DATABASE_HOST=localhost DATABASE_PORT=5432 DATABASE_NAME=myapp

envdoc clear-values [file]

Clears all values from an environment file, leaving only the keys. This is a dangerous operation requiring PIN confirmation.

envdoc sync [file1] [file2] [fileN...]

Synchronizes keys across multiple files, adding missing keys with empty values.

envdoc audit [file]

Generates a report of duplicate keys and missing values in a file.

Example Report:

# Environment Variables Audit Report ## Overview **File:** `.env` **Total Keys:** 15 **Duplicate Keys:** 1 **Keys with Missing Values:** 3 ## Duplicate Keys | Key | |-----| | `API_KEY` | ## Keys with Missing Values | Key | |-----| | `DATABASE_PASSWORD` | | `API_SECRET` | | `SMTP_PASSWORD` |

envdoc compare [file1] [file2] [fileN...]

Generates a comparison report showing missing keys across files.

Example Report:

# Environment Variables Comparison Report ## Overview **Files Compared:** 3 ## Files Analyzed - `.env.development` (10 keys) - `.env.staging` (12 keys) - `.env.production` (12 keys) ## Missing Keys ### Missing in `.env.development` | Key | |-----| | `SSL_CERT` | | `SSL_KEY` |

envdoc doctor

Audits all .env files in the current directory.

envdoc engineer

Synchronizes and arranges all .env files in the current directory.

envdoc validate [file] [schema-file]

Validates a .env file against a JSON schema.

envdoc to [json|yaml] [file]

Converts .env file to JSON or YAML format.

envdoc from [file]

Converts JSON or YAML file to .env format.

envdoc encrypt [file]

Encrypts a file using AES-256-CBC with PBKDF2 key derivation.

envdoc decrypt [file]

Decrypts an encrypted file.

envdoc hash [file]

Generates and displays SHA256 hash of a file.

envdoc base64 [encode|decode] [file]

Encodes or decodes a file using base64.

envdoc version # Show version envdoc documentation # Open documentation envdoc license # Show license envdoc changelog # Show changelog envdoc authors # Show authors

# Create a template for new developers envdoc create-example .env.production .env.example # Create a schema for validation envdoc create-schema .env.production .env.schema.json # Validate staging environment envdoc validate .env.staging .env.schema.json

# Compare environments envdoc compare .env.development .env.staging .env.production # Sync missing keys envdoc sync .env.development .env.staging .env.production # Arrange all files envdoc arrange .env.development envdoc arrange .env.staging envdoc arrange .env.production

# Encrypt production secrets envdoc encrypt .env.production # Generate hash for verification envdoc hash .env.production.encrypted # Later, decrypt when needed envdoc decrypt .env.production.encrypted

# In your CI/CD pipeline envdoc validate .env $SCHEMA_FILE || exit 1 envdoc compare .env .env.example || exit 1

• Quickly create .env.example files for new team members
• Validate local environment against production schema
• Keep track of required environment variables

• Audit environment configurations across multiple deployments
• Ensure consistency between staging and production
• Generate documentation for environment variables

• Encrypt sensitive configuration files
• Verify file integrity with hash generation
• Track changes in environment configurations

We welcome contributions! Please follow these steps:

1. Fork the repository

   git clone https://github.com/YOUR_USERNAME/envdoc-go.git cd envdoc-go

2. Create a feature branch

   git checkout -b feature/amazing-feature

3. Make your changes

   • Write clean, documented code
   • Follow Go best practices
   • Add tests for new features

4. Test your changes

   go test ./... go build -o envdoc . ./envdoc --help

5. Commit your changes

   git add . git commit -m "Add amazing feature"

6. Push to your fork

   git push origin feature/amazing-feature

7. Open a Pull Request

   • Go to the original repository
   • Click "New Pull Request"
   • Select your branch
   • Describe your changes

• Follow Effective Go guidelines
• Use gofmt to format your code
• Write clear commit messages
• Add comments for complex logic

# Clone the repository git clone https://github.com/MayR-Labs/envdoc-go.git cd envdoc-go # Install dependencies go mod download # Build the project go build -o envdoc . # Run tests go test ./... # Run linter (if installed) golangci-lint run

If you find a bug, please create an issue with:

• Clear title: Briefly describe the problem
• Description: Detailed explanation of the issue
• Steps to reproduce: How to reproduce the bug
• Expected behavior: What should happen
• Actual behavior: What actually happens
• Environment: OS, Go version, envdoc version
• Screenshots: If applicable

Example:

Title: envdoc sync fails with special characters in keys Description: When syncing files with keys containing special characters like '@' or '$', the command crashes with a parse error. Steps to reproduce: 1. Create .env with KEY@TEST=value 2. Run: envdoc sync .env .env.test 3. Observe error Expected: Files should sync successfully Actual: Parse error: invalid character '@' Environment: - OS: Ubuntu 22.04 - Go: 1.21 - envdoc: v0.1.0 

To request a feature:

1. Check if it already exists in issues
2. Create a new issue with the label enhancement
3. Describe:
   • The problem you're trying to solve
   • Your proposed solution
   • Alternative solutions you've considered
   • Any additional context

This project is licensed under the MIT License - see the LICENSE file for details.

Built with ❤️ by MayR Labs

• Cobra - CLI framework
• Survey - Interactive prompts
• godotenv - .env file parsing
• All our contributors

For more detailed documentation, visit our documentation page.

• GitHub Repository
• Issue Tracker
• Releases
• Changelog

If you find envdoc helpful, please give it a star on GitHub!

Made with ❤️ by MayR Labs | GitHub @MayR-Labs | Website (mayrlabs.com)