|
| 1 | ++++ |
| 2 | +title = "envcheck Documentation" |
| 3 | +sort_by = "weight" |
| 4 | +template = "section.html" |
| 5 | +weight = 0 |
| 6 | + |
| 7 | +[extra] |
| 8 | +hero_title = "envcheck" |
| 9 | +hero_subtitle = "Fast .env linter with DevSecOps superpowers. Written in Rust 🦀" |
| 10 | +hero_buttons = [ |
| 11 | + { text = "Get Started", link = "/installation", class = "btn-primary" }, |
| 12 | + { text = "GitHub", link = "https://github.com/envcheck/envcheck", class = "btn-secondary" } |
| 13 | +] |
| 14 | ++++ |
| 15 | + |
| 16 | +## What is envcheck? |
| 17 | + |
| 18 | +**envcheck** is a fast, modern Rust CLI for linting `.env` files and ensuring environment synchronization across your entire DevSecOps stack. |
| 19 | + |
| 20 | +## Why envcheck? |
| 21 | + |
| 22 | +| Feature | envcheck 🦀 | dotenv-linter | |
| 23 | +|---------|-------------|---------------| |
| 24 | +| **Linting** | ✅ | ✅ | |
| 25 | +| **Compare** | ✅ | ✅ | |
| 26 | +| **K8s Sync** | ✅ | ❌ | |
| 27 | +| **Terraform** | ✅ | ❌ | |
| 28 | +| **Ansible** | ✅ | ❌ | |
| 29 | +| **Helm** | ✅ | ❌ | |
| 30 | +| **ArgoCD** | ✅ | ❌ | |
| 31 | +| **GitHub Actions Check** | ✅ | ❌ | |
| 32 | +| **TUI Mode** | ✅ | ❌ | |
| 33 | +| **SARIF Output** | ✅ | ❌ | |
| 34 | +| **Config Files** | ✅ | ❌ | |
| 35 | +| **Shell Completions** | ✅ | ❌ | |
| 36 | +| **Auto-Fix + Commit/PR** | ✅ | ✅ (fix only) | |
| 37 | + |
| 38 | +## DevSecOps Integrations |
| 39 | + |
| 40 | +| Integration | Command | What it checks | |
| 41 | +|-------------|---------|----------------| |
| 42 | +| **Kubernetes** | `envcheck k8s-sync` | SecretKeyRef/ConfigMapKeyRef vs `.env` | |
| 43 | +| **Terraform** | `envcheck terraform` | `TF_VAR_*` variable usage | |
| 44 | +| **Ansible** | `envcheck ansible` | `lookup('env', 'VAR')` calls | |
| 45 | +| **GitHub Actions** | `envcheck actions` | `env:` blocks in workflows | |
| 46 | +| **Helm** | `envcheck helm` | `SCREAMING_SNAKE_CASE` in `values.yaml` | |
| 47 | +| **ArgoCD** | `envcheck argo` | `plugin.env` and `kustomize.commonEnv` | |
| 48 | + |
| 49 | +## License |
| 50 | + |
| 51 | +MIT License - See [GitHub](https://github.com/envcheck/envcheck) for details. |
0 commit comments