configdrift

# ConfigDrift [](https://github.com/Coding-Dev-Tools/configdrift/stargazers) Keep configurations consistent across all environments, automatically. ConfigDrift compares configs, flags drift, and reports compliance violations before they cause incidents. > ⭐ **Star this repo** if you manage multi-environment configs — it helps other devs find ConfigDrift! [](https://github.com/Coding-Dev-Tools/configdrift/releases)  [](https://github.com/Coding-Dev-Tools/configdrift/blob/main/LICENSE) [](https://www.opensourcealternative.to/project/configdrift) |[](https://www.libhunt.com/r/Coding-Dev-Tools/configdrift) Real-world scenarios: - **Multi-environment compliance**: Ensure staging and prod configs are identical before every deploy - **Secrets audit**: Detect env vars that exist in one environment but are missing in another - **CI/CD gating**: Block PRs that introduce config drift across environments - **Incident prevention**: Catch a changed database endpoint before it causes a production outage ## Installation > ConfigDrift is **not published to public PyPI**. Install from the self-hosted index, a direct GitHub install, or via Homebrew/Scoop (below). ```bash # Install directly from GitHub (recommended) pip install git+https://github.com/Coding-Dev-Tools/configdrift.git ``` Editable install for development: ```bash pip install -e ".[dev]" ``` Then run: `configdrift --help` ## Quick Start Compare two config files: ```bash configdrift check dev.yaml prod.yaml ``` Scan entire directories as environments: ```bash configdrift scan ./config/dev ./config/staging ./config/prod ``` Use a config file to define environments: ```bash configdrift init configdrift scan --config .configdrift.yaml ``` ## Usage ### `check` — Compare config files ```bash configdrift check <file1> <file2> [--output table|json|silent] [--baseline dev] [--target prod] ``` Output formats: - `table` (default): Rich colored table output - `json`: Machine-readable JSON for CI integration - `silent`: Exit code only (0 = no breaking drift, 1 = breaking drift found) ### `scan` — Compare environment directories ```bash configdrift scan ./dev ./staging ./prod --baseline dev ``` Scans all config files in each directory, merges them, and compares against a baseline environment. ### `init` — Generate a config file ```bash configdrift init . ``` Creates `.configdrift.yaml` in the specified directory. ### CI/CD Integration Use `--output silent` for CI gating: ```bash configdrift check dev.yaml prod.yaml --output silent || echo "Drift detected!" ``` ### GitHub Actions example ```yaml - name: Detect config drift run: | pip install git+https://github.com/Coding-Dev-Tools/configdrift.git configdrift check ./config/staging/app.yaml ./config/prod/app.yaml --output silent ``` ## Troubleshooting - **Exit code 1 with no output**: use `--output table` to inspect drift details. - **TOML parsing errors on Python < 3.11**: install `tomli` and `tomli-w` or use Python 3.11+. - **Large config scans are slow**: narrow the scan to changed files or a single directory. - **Unexpected breaking drift**: review severity rules in the project settings; `database*` and `auth*` keys are flagged as breaking by default. ## Supported Formats | Format | Extension | Notes | |---------|---------------|-------------------------------| | YAML | `.yaml`, `.yml` | Full nested structure support | | JSON | `.json` | Nested flattening | | TOML | `.toml` | Python 3.11+ native | | .env | `.env` | `KEY=VALUE` format | ## Severity Levels - **Info**: Non-critical value changes - **Warning**: Added or removed optional keys - **Breaking**: Changes to critical keys (`database*`, `auth*`, `api_key*`, `secret*`, `password*`, `token*`, `endpoint*`) ## Development ```bash # Install with dev dependencies pip install -e ".[dev]" # Run tests pytest # Run with coverage pytest --cov=configdrift ``` ## Pricing ConfigDrift is one of 11 tools in the Revenue Holdings suite. One license covers all CLI tools. | Plan | Price | Best For | |------|-------|----------| | **Free** | $0 | Individual devs, OSS — CLI only, 1 env pair | | **ConfigDrift Individual** | **$15/mo** ($12 billed annually) | Professional devs — unlimited environments, custom rules | | **Suite (all 11 tools)** | **$49/mo** ($39 billed annually) | Full Revenue Holdings toolkit — 40% savings | | **Team** | **$79/mo** ($63 billed annually) | Up to 5 devs — drift history, Slack alerts, priority support | | **Enterprise** | Custom | SSO, RBAC, compliance reports, dedicated support | 🔹 **No lock-in**: CLI works fully offline on the free tier — no telemetry, no phone-home. 🔹 **Annual billing**: Save 20%. ### Per-Tier Features | Feature | Free | ConfigDrift | Suite | Team | Enterprise | |---------|:----:|:-----------:|:-----:|:----:|:----------:| | CLI: check, scan | ✓ | ✓ | ✓ | ✓ | ✓ | | Unlimited environments | — | ✓ | ✓ | ✓ | ✓ | | Custom rules / policies | — | ✓ | ✓ | ✓ | ✓ | | Drift history / audit trail | — | — | — | ✓ | ✓ | | Slack / webhook alerts | — | — | — | ✓ | ✓ | | Compliance reports | — | — | — | — | ✓ | | RBAC | — | — | — | — | ✓ | | SSO / SAML / OIDC | — | — | — | — | ✓ | | Priority support | Community | 24h | 24h | 8h | Dedicated | --- <p align="center"> _{Part of <a href="https://coding-dev-tools.github.io/devforge/">Revenue Holdings</a> — CLI tools built by autonomous AI.} </p> ## License MIT ## Test ```bash npm test # runs: node --test tests/ ```