Skip to main content

Compare .env against .env.example and find missing or undocumented variables

Project description

envwarden

Compare .env against .env.example and find missing or undocumented variables — great for CI and onboarding.

Install

pip install envwarden

Usage

# Auto-detect .env and .env.example in current directory
envwarden

# Scan a specific project directory
envwarden /path/to/project

# Ignore undocumented keys (don't flag .env-only vars)
envwarden --allow-extra

# Don't warn about empty values
envwarden --no-warn-empty

# CI-friendly: only print issues, exit 0/1
envwarden --quiet

Example output

env:     .env
example: .env.example

✗ Missing (2) — required by .env.example but not in .env:
    DATABASE_URL
    REDIS_URL

⚠ Undocumented (1) — in .env but not in .env.example:
    MY_LOCAL_DEBUG_FLAG

⚠ Empty (1) — keys with no value set:
    SECRET_KEY

Exits with code 1 when missing or extra keys are found, 0 when all clear.

Supported example file names

  • .env.example
  • .env.sample
  • .env.template

CI integration

- name: Verify .env matches .env.example
  run: envwarden --quiet

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

envwarden-0.2.0.tar.gz (7.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

envwarden-0.2.0-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

Details for the file envwarden-0.2.0.tar.gz.

File metadata

  • Download URL: envwarden-0.2.0.tar.gz
  • Upload date:
  • Size: 7.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for envwarden-0.2.0.tar.gz
Algorithm Hash digest
SHA256 fda79628d838d755492de6db8808c9e8a48814491d1e27241ffc41d553c5dfbf
MD5 1337603881f3388c33032b75755d6a1e
BLAKE2b-256 676d322a983a7d0f71f8b080286ac9b3ed9360d498d9462bcaffda971753d6b3

See more details on using hashes here.

File details

Details for the file envwarden-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: envwarden-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 6.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for envwarden-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d38feab2f72e8331447d82c75f44e1bcf7e886a622f88048fd2f15ea681490c0
MD5 98d4888964e19ebcccb350ac3a8df8b1
BLAKE2b-256 39e25e803f9d8745d702a4217fe7855febcbe8f599e7b9733b4a1f98f7ddc65a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page