🚀 docsage

AI-powered README generator

Key Features • Installation • Usage • Documentation • Contributing

✨ Key Features

• 🤖 AI-Powered Analysis - Leverages Google's Gemini model for intelligent code analysis
• 📝 Smart Generation - Creates comprehensive README files with all essential sections
• 🔍 Code Structure Detection - Automatically detects and documents project structure
• 📊 Dependency Analysis - Parses and categorizes project dependencies
• 📈 Mermaid Diagrams - Generates architecture and flow diagrams automatically
• 🎨 Beautiful CLI - Interactive command-line interface with colorful output
• 🔄 Merge Support - Smart merging with existing README files
• ⚡ Fast & Efficient - Optimized file scanning and processing
• 🔃 GitHub Integration - Create pull requests automatically with generated docs
• 🔐 Secure - Environment-based configuration for sensitive tokens

🚀 Quick Start

Prerequisites

• Node.js >= 16
• npm or yarn
• Google Gemini API key

📥 Installation

npm install -g docsage

Usage

docsage [path]

Example:

docsage ./my-project

or

docsage # This will scan the current directory

Interactive Mode

docsage -i

Advanced Options

| Option | Description | |--------|-------------| | -c, --codebase | Specify codebase path | | -f, --force | Force overwrite existing README | | -m, --merge | Merge with existing README | | -i, --interactive | Interactive mode |

📖 Documentation

CLI Architecture

graph TD
A[CLI Entry] --> B{Parse Options}
B --> C[Interactive Mode]
B --> D[Direct Mode]
C --> E[File Scanner]
D --> E
E --> F[Code Analyzer]
F --> G[README Generator]
G --> H{Existing README?}
H -->|Yes| I[Merge Content]
H -->|No| J[Write New File]

Features

• AI-powered code analysis
• Automatic generation of detailed README.md files
• Support for code structure detection and dependency parsing
• Integration with Mermaid for diagram generation
• Customizable templates

Dependencies

Runtime:

• @google/generative-ai
• commander
• dotenv
• fast-glob
• ora
• chalk
• mermaid
• badge-maker

Contributing

-Fork the repo -Create a new branch -Make your changes -Commit your changes -Push your changes -Create a pull request

Contributions are welcome! Please read the contributing guidelines before submitting a pull request.

Development:

• esbuild
• jest

License

MIT This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• Google Gemini for AI capabilities
• Osei Ansah
• Expo Ghana Community
• Samuel Agbenyo
• All our contributors

Made with ❤️ by @Okenneth1946