You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/advanced/_index.md
+12-2Lines changed: 12 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,16 @@ sort_by = "weight"
5
5
template = "section.html"
6
6
+++
7
7
8
-
# Advanced Topics
8
+
# Tailored to Your Workflow
9
9
10
-
Advanced configuration and usage of envcheck.
10
+
Every project is unique. While `envcheck` comes with sensible defaults, it offers deep configuration options to match your team's specific needs.
11
+
12
+
## Customization Options
13
+
14
+
***[.envcheckrc](/configuration/envcheckrc)**: Define global rules, excluded keys, and varying severity levels (Error, Warning, Info) in a simple TOML or YAML file.
15
+
***Ignore Files**: Use `.envcheckignore` (similar to `.gitignore`) to skip specific files or directories.
16
+
***Rule Toggling**: Enable or disable specific checks. Legacy project with lowercase keys? No problem—just disable `KeyFormat` check.
17
+
18
+
## Scalable Configuration
19
+
20
+
For large organizations, you can share configuration presets across multiple repositories, ensuring a consistent security posture across your entire engineering organization.
Copy file name to clipboardExpand all lines: content/commands/_index.md
+18-2Lines changed: 18 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,22 @@ sort_by = "weight"
5
5
template = "section.html"
6
6
+++
7
7
8
-
# Commands Reference
8
+
# Powerful Tools at Your Fingertips
9
9
10
-
Complete reference for all envcheck commands.
10
+
`envcheck` provides a suite of commands designed to handle every aspect of environment variable management, from local development to production validation.
11
+
12
+
## Core Commands
13
+
14
+
***[Lint](/commands/lint)**: The workhorse. Scans your `.env` files for syntax errors, duplication, and best-practice violations.
15
+
***[Compare](/commands/compare)**: The team saver. Checks your `.env` against a reference (like `.env.example`) to ensure you haven't missed any new keys.
16
+
***[Fix](/commands/fix)**: The time saver. Automatically parses and corrects common formatting issues safely.
17
+
***[TUI](/commands/tui)**: The visualizer. An interactive terminal interface for exploring and comparing environment files.
18
+
19
+
## Philosophy
20
+
21
+
All commands follow the **Unix philosophy**: do one thing well. They are designed to be composable, with standardized exit codes and optional JSON output for machine parsing.
Copy file name to clipboardExpand all lines: content/integration/_index.md
+16-2Lines changed: 16 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,20 @@ sort_by = "weight"
5
5
template = "section.html"
6
6
+++
7
7
8
-
# Integration Guide
8
+
# Seamless Integration, Everywhere
9
9
10
-
Learn how to integrate envcheck into your development workflow.
10
+
Security isn't something you do once; it's a continuous process. `envcheck` is designed to "shift left"—catching configuration issues as early as possible in your development lifecycle.
11
+
12
+
## Workflow Integrations
13
+
14
+
1.**Local Development**: Use [pre-commit hooks](/integration/pre-commit) to prevent bad env files from ever being committed.
15
+
2.**CI Pipelines**: Run `envcheck` in GitHub Actions, GitLab CI, or CircleCI to block broken builds.
16
+
3.**Deployment**: Verify Kubernetes Secrets or Docker containers before they go live.
17
+
18
+
## The "Shift Left" Advantage
19
+
20
+
By integrating `envcheck` into your CI/CD pipeline, you gain:
21
+
22
+
***Zero-Config Security**: Block commits that contain `AWS_SECRET_KEY` or other sensitive patterns.
23
+
***Production Parity**: Ensure that the keys defined in `env.production` match what your application expects code-wise.
24
+
***Audit Trail**: Generate [SARIF reports](/integration/output-formats) for GitHub Security tab integration.
Copy file name to clipboardExpand all lines: content/introduction/_index.md
+25-2Lines changed: 25 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,29 @@ sort_by = "weight"
5
5
template = "section.html"
6
6
+++
7
7
8
-
# Introduction
8
+
# The Standard for Modern Environment Management
9
9
10
-
Welcome to envcheck! This section will help you get started with the tool.
10
+
**envcheck** is a lightning-fast, safety-first CLI tool designed to bring sanity to your `.env` files. In modern cloud-native development, environment variables are the nervous system of your application. Broken configuration leads to downtime, security leaks, and wasted debugging hours.
11
+
12
+
We built `envcheck` to stop these issues before they start.
13
+
14
+
## Why envcheck?
15
+
16
+
***🛡️ Safety First**: Prevents valid-looking but broken configurations from hitting production.
17
+
***⚡ Blazing Fast**: Written in Rust to run instantly in your pre-commit hooks and CI pipelines.
18
+
***🧠 Intelligent**: Understands popular framework patterns (Next.js, Django, Rails) and cloud providers.
19
+
***🤝 Collaborative**: Helps teams stay in sync by flagging missing keys in local environments.
20
+
21
+
## Quick Start
22
+
23
+
Get up and running in seconds:
24
+
25
+
```bash
26
+
# Install via npm
27
+
npx envcheck@latest init
28
+
29
+
# Or via cargo
30
+
cargo install envcheck
31
+
```
32
+
33
+
Ready to dive deeper? Check out the [Commands](/commands) reference or learn about [CI/CD Integration](/integration).
Copy file name to clipboardExpand all lines: content/whats-new/_index.md
+16-2Lines changed: 16 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,20 @@ sort_by = "weight"
5
5
template = "section.html"
6
6
+++
7
7
8
-
# What's New
8
+
# Changelog & Updates
9
9
10
-
Release notes and changelog for envcheck.
10
+
We are committed to **Semantic Versioning**. This means no breaking changes without a major version bump, so you can upgrade with confidence.
11
+
12
+
## Latest Updates
13
+
14
+
### v1.0.0 - The Initial Release
15
+
***Core**: First stable release of the Rust CLI.
16
+
***Feature**: Complete Lint, Fix, and Compare commands.
17
+
***Integration**: GitHub Actions support and SARIF output.
18
+
***Docs**: Launch of this documentation site!
19
+
20
+
### Roadmap
21
+
We move fast. Check out our [GitHub Repository](https://github.com/envcheck/envcheck) to see what's coming next, or to request a feature. Current priorities include:
0 commit comments