Effortlessly document your .env files with Dotscribe.
Dotscribe is a powerful tool designed to help developers understand and document their environment variables. It automatically analyzes your .env files, providing clear descriptions, expected formats, and crucially, detecting any sensitive secrets.
- Smart Inference: Automatically detects the purpose of variables based on common naming conventions and patterns.
- Secret Detection: Flags API keys, tokens, and other credentials to prevent accidental commits to version control.
- CLI & Web Access: Use the intuitive web application for quick checks or integrate the command-line interface (CLI) into your development workflow.
- Markdown Export: Generate a documentation-ready table for your README file, making it easy to share variable information.
- Instant Results & Privacy: No signup is required. Processing happens entirely client-side, ensuring your secrets never leave your browser.
Getting started is simple:
- Drop your .env: Paste your .env or .env.example content, or drag and drop the file.
- We analyze it: Dotscribe parses your variables, infers their purpose, and identifies secrets.
- Get documentation: Copy the documented version or export it as a markdown table for your project's documentation.
The CLI tool integrates seamlessly into your workflow:
- Document .env files in the current directory: $ npx dotscribe@latest
- Output documented version to a file: $ npx dotscribe@latest -o .env.documented
- Generate a markdown table for docs: $ npx dotscribe@latest --markdown
- Enable strict mode to fail if secrets are detected without a .gitignore: $ npx dotscribe@latest --strict
Dotscribe is free to use, fast, and works offline, making it an essential tool for developers who want to maintain clean and well-documented codebases.