Env File Manager (envm)

A comprehensive CLI tool for managing environment files (.env) with advanced features including encryption, backup management, validation, and multi-environment configuration handling.

🚀 Key Highlights

💎 Military-Grade Security | 🔐 AES-256-GCM Encryption | ⚡ Lightning Fast | 🛡️ Git Protection | 📦 Multi-Platform

---

✨ Features

• Military-grade encryption - AES-256-GCM with PBKDF2 key derivation
• Automatic backups - Safe file operations with recovery options
• Environment validation - Schema-based validation with type checking
• Multi-environment management - Switch between different environments easily
• Export functionality - Convert to JSON/YAML formats
• Variable-specific encryption - Encrypt individual sensitive variables
• Git ignore guard - Security warnings for tracked environment files
• Advanced profiles - Group and manage environment configurations
• Security-first design - Password protection and data integrity
• Comprehensive CLI - Full command-line interface with rich options

⚡ Quick Start

🎯 Get Started in 60 Seconds

# 1. Install globally
npm install -g envm

# 2. Create your environment file
echo "NODE_ENV=development" > .env
echo "API_KEY=your-secret-key" >> .env

# 3. Validate & secure immediately
envm validate
envm gitignore init
envm encrypt .env --key yourpassword

# 4. Switch environments
envm switch production

📋 Prerequisites

• Node.js >= 18.0.0 (Download)
• npm or yarn package manager
• Git (recommended for version control)

Installation

Option 1: NPM (Recommended)

# Install globally
npm install -g @nom-nom-hub/envm

# Verify installation
envm --version
envm --help

Option 2: Homebrew (macOS/Linux)

# Add our tap (when published)
brew tap envm/tap
brew install envm

# Or install directly from formula
brew install nom-nom-hub/envm/envm

Option 3: Linux Installation Script

# Download and run the installer
curl -fsSL https://raw.githubusercontent.com/nom-nom-hub/envm/main/install.sh | bash

# Or download manually and run
wget https://raw.githubusercontent.com/nom-nom-hub/envm/main/install.sh
chmod +x install.sh
./install.sh

Option 4: Manual Installation

# Clone the repository
git clone https://github.com/nom-nom-hub/envm.git
cd envm

# Install dependencies
npm install

# Link globally (preferred)
npm link

# Or use directly
npx envm --help

# Alternative global installation
npm install -g .

Option 5: Docker

# Run in Docker container
docker run --rm -v $(pwd):/app envm/envm --help

# Or build locally
docker build -t envm .
docker run --rm -v $(pwd):/app envm

Basic Usage

cd your-project/

# Create a new .env file
echo "NODE_ENV=development" > .env
echo "API_KEY=your-api-key" >> .env
echo "DB_PASSWORD=your-password" >> .env

# Validate configuration
envm validate

# Create backup
envm backup my-app-config

# Encrypt sensitive variables
envm encrypt .env --variable=API_KEY
envm encrypt .env --variable=DB_PASSWORD

# Switch to production
envm switch production

Commands

Core Commands

envm validate [options]

Validates environment configuration against a schema file.

# Validate using .env.example as schema
envm validate

# Specify custom schema and environment files
envm validate --schema config.schema --env .env.staging

# Show detailed validation report
envm validate --verbose

# Fail on any discrepancy
envm validate --strict

Options:

• -s, --schema <file> - Schema file (default: .env.example)
• -e, --env <file> - Environment file (default: .env)
• -p, --path <dir> - Working directory
• -v, --verbose - Detailed report
• --strict - Fail on any issues
• --no-exit - Don't exit on validation failure

envm switch <config> [options]

Switch between different environment configurations.

# Switch to production configuration
envm switch production

# Force switch (overwrite without confirmation)
envm switch staging --force

# Create backup before switching
envm switch development --backup

Options:

• -f, --force - Force overwrite
• -p, --path <dir> - Working directory
• -b, --backup - Create backup before switching

envm export [options]

Export environment variables to JSON or YAML format.

# Export to JSON
envm export --format json --output config.json

# Export to YAML
envm export --format yaml --output config.yaml

# Export to stdout
envm export --format json

# Specify input file
envm export --env .env.production --format yaml

Options:

• -f, --format <format> - Output format (json, yaml)
• -e, --env <file> - Input environment file
• -o, --output-file <file> - Output file path
• -p, --path <dir> - Working directory

Backup Commands

envm backup [name] [options]

Create backup of environment files.

# Create auto-named backup
envm backup

# Create named backup
envm backup pre-deploy-2025

# Create compressed backup
envm backup nightly --compress

# List all backups
envm backup --list

# Git ignore guard (security for environment files)
envm gitignore check
envm gitignore init
envm gitignore add

# Advanced profiles (environment grouping)
envm profile list
envm profile create <name>
envm profile delete <name>

Options:

• -p, --path <dir> - Working directory
• -c, --compress - Compress backup
• -l, --list - List available backups

envm restore <backup> [options]

Restore environment files from backup.

# Restore from named backup
envm restore my-backup

# Restore from timestamp
envm restore 2025-09-01_14-30-00

# Force restore (overwrite existing files)
envm restore my-backup --force

# Create backup of current state before restore
envm restore my-backup --backup-current

# Verify backup before restore
envm restore my-backup --verify

Options:

• -p, --path <dir> - Working directory
• -f, --force - Force overwrite
• -v, --verify - Verify backup integrity
• -b, --backup-current - Backup current state

envm gitignore <action> [options]

Check and manage .env files in Git ignore for security.

# Check current .gitignore status and warnings
envm gitignore check

# Create new .gitignore with env patterns
envm gitignore init

# Add env patterns to existing .gitignore
envm gitignore add

# Remove tracked .env files from Git (CAUTION!)
envm gitignore clean --force

Actions:

• check, status - Analyze Git ignore status and security
• init - Create new .gitignore with env patterns
• add - Add env patterns to existing .gitignore
• clean - Remove tracked files from Git (use --force)

envm profile <action> [name] [options]

Manage advanced environment profiles (groups of env files).

# List all profiles
envm profile list

# Create a new profile
envm profile create development --description "Development env"

# Delete a profile
envm profile delete development --force

Actions:

• list, ls - List all profiles
• create, new - Create new profile
• delete, remove - Delete a profile

Encryption Commands

envm encrypt <env> [options]

Encrypt environment files using AES-256-GCM encryption.

# Encrypt entire file
envm encrypt .env --key mypassword123

# Encrypt specific variable
envm encrypt .env --variable API_KEY --key mypassword123

# Use environment variable for password
export ENVM_ENCRYPTION_KEY=mypassword123
envm encrypt .env --variable DB_PASSWORD

# Skip automatic backup
envm encrypt .env --key mypassword123 --no-backup

# Specify output file
envm encrypt .env --key mypassword123 --output .env.production.enc

# Force overwrite existing file
envm encrypt .env --key mypassword123 --force

Options:

• -k, --key <password> - Encryption password
• -v, --variable <name> - Encrypt specific variable only
• -o, --output <file> - Output file path
• -p, --path <dir> - Working directory
• -f, --force - Force overwrite
• --no-backup - Skip automatic backup

envm decrypt <env> [options]

Decrypt environment files that were encrypted with AES-256.

# Decrypt entire file
envm decrypt .env.encrypted --key mypassword123

# Decrypt specific variable only
envm decrypt .env.encrypted --variable API_KEY --key mypassword123

# Use environment variable for password
export ENVM_ENCRYPTION_KEY=mypassword123
envm decrypt .env.encrypted

# Specify output file
envm decrypt .env.encrypted --key mypassword123 --output .env.decrypted

# Force overwrite existing file
envm decrypt .env.encrypted --key mypassword123 --force

# Create backup before decryption
envm decrypt .env.encrypted --key mypassword123 --backup-current

Options:

• -k, --key <password> - Decryption password
• -v, --variable <name> - Decrypt specific variable only
• -o, --output <file> - Output file path
• -p, --path <dir> - Working directory
• -f, --force - Force overwrite
• -b, --backup-current - Backup current state

🔒 Security Features

Encryption Security

• AES-256-GCM encryption algorithm
• PBKDF2 key derivation with random salt
• Unique IV per encryption operation
• Authentication tags for integrity verification
• Metadata storage with encryption parameters

Password Management

# Use environment variable (recommended)
export ENVM_ENCRYPTION_KEY=your-strong-password
envm encrypt .env

# Use command line (less secure)
envm encrypt .env --key "YourSecurePassword123!"

# Best practices:
# - Use 20+ character passwords
# - Include letters, numbers, and symbols
# - Never store passwords in scripts
# - Use environment variables in CI/CD

Encrypted File Format

Encrypted files contain:

• Encryption metadata (version, algorithm, timestamp)
• Salt for key derivation
• Initialization vector (IV)
• Authentication tag
• Encrypted data

File extension: .encrypted

🛠️ Configuration

Environment Variables

# Set default working directory
export ENVM_PATH=/path/to/project

# Set encryption password globally
export ENVM_ENCRYPTION_KEY=your-password

# Set backup compression by default
export ENVM_COMPRESS_BACKUPS=true

Custom Schema Files

Create .env.example for validation schema:

# .env.example
NODE_ENV=development
API_URL=http://localhost:3000
DATABASE_URL=postgresql://localhost:5432/myapp
SECRET_KEY=your_secret_key_here

Project Configuration

// In your project's package.json, add:
{
  "scripts": {
    "env:validate": "envm validate",
    "env:backup": "envm backup",
    "env:encrypt": "envm encrypt .env --variable SECRET_KEY",
    "env:switch:prod": "envm switch production"
  }
}

📁 Project Structure

envm/
├── bin/
│   └── envm              # CLI executable
├── src/
│   └── index.js          # Main CLI code
├── .envm/
│   └── backups/          # Backup storage
├── package.json
├── README.md
└── ...

Example usage:
your-project/
├── .env                  # Current environment
├── .env.production       # Production config
├── .env.staging          # Staging config
├── .env.example          # Schema/validation
└── .envm/
    └── backups/          # Automatic backups

🔧 Development

Setup for Development

git clone https://github.com/nom-nom-hub/envm.git
cd envm
npm install
npm link

# Run tests
npm test

# Run in development
npm run dev

Building from Source

# Install dependencies
npm install

# Create executable
chmod +x bin/envm

# Test locally
./bin/envm --version

Adding New Commands

1. Add command in src/index.js
2. Implement handler function
3. Update this README
4. Add tests

🐛 Troubleshooting

Common Issues

"Command not found"

# Install globally
npm install -g envm

# Or link locally
cd envm-project
npm link

"Invalid encrypted file format"

• Ensure file has .encrypted extension
• Check password is correct
• Verify file wasn't corrupted

"Directory not found"

# Specify working directory
envm encrypt .env --path /path/to/project

"Validation failed"

• Check .env.example schema file exists
• Compare types and required variables
• Use --verbose for detailed report

🤝 Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/new-feature)
3. Commit your changes (git commit -am 'Add new feature')
4. Push to the branch (git push origin feature/new-feature)
5. Create a Pull Request

Development Guidelines

• Use ESLint configuration
• Add tests for new features
• Update documentation
• Follow Node.js best practices
• Use semantic commit messages

📄 License

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

🙏 Acknowledgments

• Built with Commander.js
• Encryption powered by Node.js crypto module
• Environment parsing with dotenv

---

🌟 Community & Support

📞 Need Help?

• 📋 Documentation: Read the Docs
• 🐛 Bug Reports: Create an Issue
• 💡 Feature Requests: Start a Discussion
• 💬 Community Chat: Join Discussions

---