envcheck

A fast, modern Rust CLI for linting .env files and ensuring environment synchronization across your entire DevSecOps stack.

✨ Features

Core

• Lint - Detects duplicate keys, invalid syntax, empty values, trailing whitespace, unsorted keys
• Compare - Identifies missing keys across multiple environment files
• Fix - Auto-fix issues with --commit and --pr flags for CI integration
• TUI - Interactive terminal UI for comparing and merging .env files

DevSecOps Integrations

Output Formats

• Text - Colored terminal output (default)
• JSON - Machine-readable for pipelines
• GitHub - Native GitHub Actions annotations
• SARIF - GitHub Security tab integration
• PR Comment - Markdown for PR/MR comments

🚀 Installation

Cargo (Recommended)

cargo install envcheck

npm

npm install -g @envcheck/cli
# or use without installing
npx @envcheck/cli lint .env

Homebrew

brew tap envcheck/tap
brew install envcheck

Binary Releases

Download pre-built binaries from GitHub Releases.

📖 Usage

Lint .env files

envcheck lint .env
envcheck lint .env .env.local .env.prod
envcheck lint .env --format json
envcheck lint .env --format sarif > results.sarif

Compare environments

envcheck compare .env.example .env.prod

Fix issues automatically

envcheck fix .env                    # Sort keys, remove whitespace
envcheck fix .env --commit           # Auto-commit changes
envcheck fix .env --pr               # Create a PR with fixes

Interactive TUI

envcheck tui .env.example .env .env.prod

K8s Sync

envcheck k8s-sync k8s/*.yaml --env .env.example

Terraform

envcheck terraform infra/ --env .env

Ansible

envcheck ansible playbooks/ --env .env

GitHub Actions

envcheck actions .github/workflows --env .env

Helm

envcheck helm charts/myapp --env .env

ArgoCD

envcheck argo argocd/apps --env .env

Shell Completions

envcheck completions bash > /etc/bash_completion.d/envcheck
envcheck completions zsh > ~/.zsh/completions/_envcheck
envcheck completions fish > ~/.config/fish/completions/envcheck.fish

📋 Lint Rules

⚙️ Configuration

Create .envcheckrc.yaml or .envcheckrc.toml in your project root:

# .envcheckrc.yaml
rules:
  disable:
    - W003  # Don't warn about unsorted keys
  warnings_as_errors: false

ignore:
  - "*.local"
  - ".env.development"

format: text

files:
  - .env
  - .env.example

.envcheckignore

# Ignore patterns (like .gitignore)
*.local
.env.development
tests/fixtures/**

JSON Schema for IDE autocompletion: https://envcheck.github.io/schema/envcheckrc.json

🔄 CI/CD Integration

GitHub Actions

- uses: envcheck/action-envcheck@v1
  with:
    command: lint
    args: .env.example .env
    format: github

Pre-commit

repos:
  - repo: https://github.com/envcheck/envcheck
    rev: v0.1.0
    hooks:
      - id: envcheck-lint
        args: [".env.example", ".env"]
      - id: envcheck-k8s
        args: ["k8s/*.yaml", "--env", ".env.example"]

GitLab CI

envcheck:
  image: rust:latest
  script:
    - cargo install envcheck
    - envcheck lint .env --format json > envcheck-report.json
  artifacts:
    reports:
      codequality: envcheck-report.json

🏗️ Architecture

envcheck/
├── envcheck/           # Core Rust CLI (this repo)
├── envcheck-npm/       # npm wrapper package
├── action-envcheck/    # GitHub Action
└── envcheck.github.io/ # Documentation website

🔧 Performance

• Parallel processing with Rayon
• Zero-copy parsing with Cow<str> for reduced allocations
• Benchmarks available via cargo bench

parse_env_file:  ~3.3 µs
lint_rules:      ~2.3 µs

🤝 Comparison

📦 Related Packages

• envcheck-npm - npm wrapper
• action-envcheck - GitHub Action
• envcheck.github.io - Documentation

📄 License

MIT