Environment Variable Documenter
Inventory environment-variable names with conservative Python alias detection and value-free reports, excluding real dotenv files before reads.
The problem it solves
Environment Variable Documenter Environment Variable Documenter is a read-only command-line tool that finds environment-variable names in common source-code patterns, reconciles them with redacted dotenv templates, and generates Markdown, JSON, or a safe .env.example.
Who Environment Variable Documenter is for
- Developers and maintainers who need reviewable evidence before changing or releasing software.
- Users working with environment variables, dotenv, documentation who want the documented v1.1.1 behavior.
- People who prefer an open-source release with visible limitations, source, and license terms.
Intended result
Inventory environment-variable names with conservative Python alias detection and value-free reports, excluding real dotenv files before reads.
This summary is reconciled from the current catalog and repository documentation.
Features in v1.1.1
Capabilities below come from the current project README and release documentation.
Environment Variable Documenter is a read-only command-line tool that finds environment-variable names in common source-code patterns, reconciles them with redacted dotenv templates, and generates Markdown, JSON, or a safe .env.example.
It inventories names and source locations. It deliberately does not read real .env values.
Verified examples
Screenshots are shown only when the current README references a local source image. Otherwise, repository example files are linked directly.
Verified release evidence
This project does not currently publish a screenshot or dedicated example folder. The current README, tests, changelog, tagged release, and source repository remain the verified examples of its behavior.
Platforms and implementation
The public release claims only the cataloged platforms and technologies.
Supported platforms
- Windows
- macOS
- Linux
Built with
- Python
Changelog
Release notes from the canonical v1.1.1 source tag.
- Correct current README release status and wheel-install links after the Python alias detection release.
- Recognize direct Python os/getenv/environ aliases using syntax trees, conservatively reject shadowed bindings, and retain value-free dynamic review items.
- Preserve default CLI policy and source safety boundaries; add regression tests and documented limits.
- Added read-only environment-variable scanning for Python, JavaScript/TypeScript, PHP, shell, and dotenv templates.
- Added documented, undocumented, unused-example, sensitive-name, and dynamic-access classifications.
- Added redacted
.env.example, Markdown, and stable JSON output. - Added explicit overwrite protection, directory exclusions, size limits, automated tests, CI, CodeQL, and release packaging.
Quick start
The shortest documented path into the current release.
Before running these source commands, download the v1.1.1 source archive, extract it, and open a terminal in the extracted project folder containing README.md. Follow the tagged README for required runtimes and any platform-specific setup.
Download and install the wheel from the v1.1.1 release:
python -m pip install "environment-variable-documenter @ https://github.com/loganpendragonmultiverse/environment-variable-documenter/releases/download/v1.1.1/environment_variable_documenter-1.1.1-py3-none-any.whl"
env-documenter . --markdown environment-variables.md --example .env.example --json environment-variables.jsonExisting outputs are preserved unless --overwrite is supplied.
Current limitations
These boundaries are part of the product and prevent the page from implying unverified capability.
- Static patterns cannot resolve names assembled at runtime.
- Framework wrappers, assignment-derived aliases, indirect configuration objects, container manifests, and every language syntax are not covered.
- Shell detection is intentionally limited to uppercase names and can still report application-local shell variables.
- “Sensitive” is a name-based warning, not proof of content or exposure.
- The tool does not verify which variables are actually set in a deployment.
Privacy and licensing
Review the actual data boundary before using a tool with sensitive inputs.
Privacy and safety
Processing is local. There are no network calls, analytics, accounts, or telemetry. Reports can reveal project structure and configuration names, so review them before publishing.
License and release
Environment Variable Documenter is published under MIT. The current cataloged release is v1.1.1, published 2026-10-15.
Related projects
Related projects are selected deterministically from shared catalog tags, category, and implementation technologies—not popularity or paid placement.
Environment Variable Documenter v1.1.1
Use the tagged release for downloads and release notes. Use the repository for source, issues, contribution guidance, security reporting, and complete documentation.
Page source: current Forge catalog plus README and CHANGELOG from the canonical GitHub release tag. Fingerprint: d84aff0f2e5be2fd.