Note

This page is soon to be deprecated. Command documentation is being moved to vaar.envaar.dev/docs.

Command Map

This page is a short and simple codebase-side map of Vaar's available commands, as well as the related developer-maintained references.

For installation, verification and the fastest first run, start with the README.

Available Commands

Command	What it does	Read more
`vaar lint [flags]`	Runs repository lint checks and optional safe fixes.	Lint guide
`vaar diff <left> <right> [flags]`	Compares key presence between two dotenv files.	Diff guide
`vaar --help` / `vaar help [command]`	Shows command help.	Help guide
`vaar completion <shell>`	Prints a shell completion script.	Completion guide
`vaar --version`	Prints the installed version.	README

Need the lint command reference, flags, exit codes or rule catalog? Read docs/lint/README.md.
Need rule-by-rule behavior and examples? Read docs/lint/rules/README.md.
Need to compare two dotenv files or use diff in CI? Read docs/diff/README.md.
Need the root help screen or help-screen behavior? Read docs/help/README.md.
Need shell setup instructions for completions? Read docs/completion/README.md.

Install Vaar and verify the binary from README.
Run vaar lint in the repository you want to check.
Use vaar lint --json --output=lint-report.json when you want to export the JSON report to a file instead of stdout.
Run vaar diff .env .env.example to compare presence of keys between a local dotenv file and example dotenv file.
Open docs/lint/README.md or docs/diff/README.md for detailed command behavior and exit codes.