Skip to main content

CLI tool to validate .env files for safety and completeness

Project description

🛡️ envguardx

envguardx is a lightweight CLI tool for validating, inspecting, and generating .env and .env.example files — with support for optional schema validation.


🚀 Features

  • ✅ Check for missing or empty env vars
  • ⚠️ Detect unsafe or insecure values
  • 🧪 Validate against a JSON schema
  • 🧬 Generate .env.example from .env
  • 🔧 Easy CLI usage with helpful output

📦 Installation

➤ Local Editable Install (Recommended for Dev)

pip install -e /absolute/path/to/envguardx

Replace /absolute/path/to/envguardx with the actual absolute path to your cloned or local project folder.

🧪 Usage

Once installed, you can run the CLI via:

envguardx --help

➤ Check an .env file

envguardx check .env

➤ Check an .env with a JSON Schema

envguardx check .env --schema schema.json

Example schema.json

{
  "API_KEY": "string",
  "DEBUG": "bool",
  "PORT": "int"
}

➤ Generate .env.example file from .env

API_KEY=
DEBUG=
PORT=

📦 Bundling

➤ To build and deploy to package repo of choice (pypi)

python -m build

To deploy

twine upload dist/*

It'll prompt you to log into your PyPI account (or you can pass -u USERNAME -p PASSWORD, or use an API token).

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

envguardx-0.1.2.tar.gz (3.2 kB view details)

Uploaded Source

Built Distribution

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

envguardx-0.1.2-py3-none-any.whl (4.1 kB view details)

Uploaded Python 3

File details

Details for the file envguardx-0.1.2.tar.gz.

File metadata

  • Download URL: envguardx-0.1.2.tar.gz
  • Upload date:
  • Size: 3.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.6

File hashes

Hashes for envguardx-0.1.2.tar.gz
Algorithm Hash digest
SHA256 ef70fb4c82262b1833a07cd780eb5c9cb0c4132e6cbd7227469f761f8e7dd0c3
MD5 83b55e97c44f41e159bb53e7152f0ab0
BLAKE2b-256 ffc868a91daedb58832623c9242685c332dcf0b40c26ec5a8983ee2172a3d124

See more details on using hashes here.

File details

Details for the file envguardx-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: envguardx-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 4.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.6

File hashes

Hashes for envguardx-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7c479f010a52d072506ff5de5c07a5cf9aa35039384f98d3c6dc3385797c6fda
MD5 bcbdd5d57daa88f08cee1923d0c8bf2c
BLAKE2b-256 966f6b387baaf75fb71211061853c9d6e42b63abc42565a2987410cc1be05fd5

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