docgenius
v1.3.2
Published
AI-powered documentation generator for your codebase
Maintainers
Readme
DocGenius
AI-powered documentation generator for your codebase.
Example Output
The generated documentation will be saved in the output directory. For example:
Features
- Automatically generates comprehensive documentation for your codebase
- Supports multiple programming languages and frameworks
- Generates both development guides and setup guides
- Supports English and Japanese output
- Uses Google's Gemini 2.5 Pro model for high-quality documentation
Usage
Basic usage:
npx docgenius --apiKey YOUR_API_KEYChange output directory:
# default ./output
npx docgenius --apiKey YOUR_API_KEY --output ./docgenius-outputWith language selection:
# English (default)
npx docgenius --apiKey YOUR_API_KEY
# Japanese
npx docgenius --apiKey YOUR_API_KEY --language jaArguments
apiKey: Your Google GenAI API keyoutput: Directory where the generated documentation will be savedlanguage: Output language (optional, default: 'en')en: Englishja: Japanese
Output
The tool generates two main documents:
development.md: Comprehensive development guide
Requirements
- Node.js v20 or later
- Google GenAI API key
Development
Setup
git clone https://github.com/your-username/docgenius.git
cd docgenius
npm installStarting Development Server
npm run dev --apikey YOUR-API-KEYLimitations
- Currently only supports Gemini 2.5 Pro model
- Does not support other AI models or versions
Contributing
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
Acknowledgments
- Google GenAI (especially Gemini 2.5 Pro)
- Mermaid.js
- Authors of other dependency libraries
License
MIT
