// guides
Learn evnx.
From first install to production CI/CD — comprehensive guides for every step.
Start Here
New to evnx?Installing evnx
Get evnx running on macOS, Linux, or Windows in under two minutes. Includes pre-commit hook setup.
Quick Start
Five minutes to your first evnx workflow — scan, validate, and convert a real .env file.
evnx init
Reference documentation for the evnx init command: modes, options, and project setup.
Browse by Section
Getting Started
8 guides
Installing evnx
Get evnx running on macOS, Linux, or Windows in under two minutes. Includes pre-commit hook setup.
Quick Start
Five minutes to your first evnx workflow — scan, validate, and convert a real .env file.
Init Basics — Start Your Project Right
Learn how to use evnx init to generate .env.example and .env files. Perfect for beginners setting up a new project.
Add Basics — Incrementally Build Your Environment
Learn how to use evnx add to incrementally add environment variables from services, frameworks, blueprints, or custom input. Perfect for beginners.
Diff Basics — Compare Environment Files
Learn how to use evnx diff to compare .env and .env.example files. Detect missing variables, spot mismatches, and keep your environment in sync.
Sync Basics — Keep .env Files in Sync
Learn how to use evnx sync to keep your .env and .env.example files synchronized. Perfect for beginners.
Convert basics
Step-by-step examples for transforming .env files with evnx convert — JSON, Kubernetes, filtering, transforms, and CI/CD pipelines.
Validate your environment: A practical guide
Learn how, when, and why to use evnx validate to catch configuration issues before they reach production.
Commands
12 guides
evnx init
Reference documentation for the evnx init command: modes, options, and project setup.
evnx add
Reference documentation for the evnx add command: subcommands, options, and incremental environment variable management.
evnx backup
Create an encrypted, portable backup of your .env file using AES-256-GCM and Argon2id key derivation.
evnx sync
Reference documentation for the evnx sync command: bidirectional sync, smart placeholders, and security features.
evnx convert
Command reference for evnx convert — flags, supported formats, transform values, glob patterns, and exit codes.
evnx diff
Reference documentation for the evnx diff command: compare .env and .env.example with auto-redaction, ordered output, and CI/CD exit codes.
evnx doctor
Diagnose environment setup issues including .env configuration, Git tracking, project structure, and security best practices. Supports JSON output for CI/CD and auto-fix for common issues.
evnx restore
Decrypt and restore a .env file from an encrypted backup created by evnx backup. Includes safety features to prevent accidental overwrites.
evnx template
Reference documentation for the evnx template command: generate configuration files from templates with variable substitution and filters.
evnx validate
Validate .env against .env.example — catch missing variables, placeholders, weak secrets, and format issues before deployment.
evnx scan
Scan .env files for secrets, high-entropy strings, and known credential patterns. Supports JSON, SARIF, and GitHub Actions annotation output.
evnx migrate
Reference documentation for the evnx migrate command: move secrets from .env files to cloud secret managers and CI/CD platforms.
Integrations
2 guides
GitHub Actions
Run evnx scan and validate in your GitHub Actions CI pipeline. Block PRs on secret detection, upload SARIF to the Security tab, and annotate pull request diffs.
CI/CD Integration for Sync Validation
Automate evnx sync validation in GitHub Actions, GitLab CI, and pre-commit hooks.
Use Cases
10 guides
Init in the Wild — Real Developer Scenarios
See how real developers use evnx init in daily workflows: Blank for scripts, Blueprint for quick starts, and Architect for custom stacks.
Migrate to GitHub Actions Secrets
Upload secrets from your .env file directly into GitHub Actions repository secrets using evnx migrate.
Team Collaboration with evnx sync
Real-world patterns for using evnx sync with multiple developers, onboarding, and merge workflows.
Production Use Cases — Real-World `evnx add` Workflows
Explore real production scenarios where `evnx add` solves environment variable management challenges — with before/after comparisons showing manual friction vs. evnx efficiency.
Migrate to AWS Secrets Manager
Generate ready-to-run AWS CLI commands to store your .env secrets in AWS Secrets Manager as a single JSON secret.
Prevent Secret Leaks
Set up a layered defense against secret leaks: pre-commit hooks, CI scanning, gitignore validation, and automated migration to a secret manager.
Migrate to GCP Secret Manager
Generate gcloud CLI commands to store each .env variable as an individual secret in Google Cloud Secret Manager.
Migrate to Platform Secret Stores
Migrate .env secrets to Doppler, Infisical, Azure Key Vault, Vercel, Heroku, or Railway using evnx migrate.
Production Use Cases — Real-World `evnx template` Workflows
Explore real production scenarios where `evnx template` eliminates manual config file editing — with before/after comparisons showing the friction of hand-crafted files vs. template-driven generation.
Migrating a Dockerised Django app from .env to AWS Secrets Manager
Step-by-step walkthrough for a DevOps engineer moving a Django + DRF application running on EC2 with Docker from flat .env files to AWS Secrets Manager — using evnx convert to handle the migration safely and repeatably.
Reference
7 guides
How evnx migrate works
Understand the evnx migration pipeline: source loading, filtering, key transforms, and how each destination is handled.
.evnx.toml Configuration
Complete reference for .evnx.toml — the optional project-level config file for evnx. Covers scan rules, validation settings, output formats, and ignore patterns.
Convert reference
Deep reference for evnx convert — format-by-format output samples, processing pipeline internals, environment variables, and troubleshooting.
Security Model -e vnx
Deep dive into evnx cryptographic architecture: AES-256-GCM encryption, Argon2id key derivation, and defense-in-depth design principles.
Writing Templates and Using Filters
Learn to write template files and use every evnx filter correctly — with precise input/output behavior, config-format guidance, and the pitfalls that cause silent misconfiguration.
Init Configuration Reference
Configuration options for evnx init: schema customization, CLI flags, and environment variables.
Sync Configuration Reference
Advanced configuration for evnx sync: placeholder JSON schema, pattern matching, and security options.
Don't have evnx yet?
Install in one command.
evnx is a single static binary. No runtime, no dependencies.