Docsage NPM | npm.io

🚀 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

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]