The "Shared Brain" for your environment variables.
Tired of cryptic .env.example files? envdoc-ai is a community-powered CLI tool that automatically scans your environment variables and generates beautiful, categorized Markdown documentation.
Built for the modern developer, it transforms chaos into clarity in seconds.
- 🧠 The Shared Brain: Every description generated by AI is stored in our global database. If someone else has documented a variable, you get their knowledge instantly.
- 🚀 Zero Config: Just run one command. No configuration, no API keys, no hassle.
- 📂 Smart Categorization: Automatically groups your variables into logical sections like
Auth,Database,API Services, and more. - 🤖 AI-Powered Inference: Uses Gemini 1.5 Flash to intelligently guess the purpose of your custom internal variables.
- 🌐 Explorer View: Browse {stats.total}+ learned variables in our Live Explorer.
Document your project instantly without installation:
npx envdoc-ai| Flag | Description |
|---|---|
-i, --input <file> |
Path to your .env.example file (default: .env.example) |
-o, --output <file> |
Output Markdown file path (default: ENV.md) |
--readme |
Append the documentation directly to your README.md |
--no-ai |
Disable the Shared Brain and use only local dictionary |
--project-name <name> |
Custom project name for the documentation header |
- Scan: Parses your
.env.examplefile for keys and default values. - Consult: Checks the Shared Brain (our global MongoDB database) for existing descriptions.
- Generate: If the variable is new, our AI service describes it and shares the knowledge back to the community.
- Format: Produces a premium, categorized Markdown table ready for your docs.
Try the transformation yourself in our Interactive Playground.
Built with ❤️ by mohitbuilds. Join the community and help document the world's variables!