ai-readme-gen

AI-powered README generator that analyzes your project and creates comprehensive documentation automatically.

Installation

npm install -g ai-readme-gen

Quick Start

# Generate README for current directory
readmegen .

# Preview without writing files
readmegen . --preview

# Write README.md directly
readmegen . --write

Features

• AI-Powered Generation - Uses OpenAI to create contextual, professional documentation
• Smart Project Analysis - Automatically detects project type, language, and framework
• Multi-Language Support - Works with Node.js, Python, Rust, Go, Java, and more
• Beautiful Terminal Preview - Styled markdown preview in your terminal
• Intelligent Templates - Falls back to smart templates when AI is unavailable
• CLI-Aware - Recognizes CLI tools vs web apps and generates appropriate content
• Structure Detection - Analyzes folder structure and dependencies

Usage Examples

Basic Usage

# Analyze current project and show preview
readmegen .

# Generate for specific directory
readmegen /path/to/project --preview

# Write README.md file
readmegen . --write

Advanced Options

# Force template mode (no AI)
readmegen . --no-ai

# Verbose output for debugging
readmegen . --verbose

# Different output formats
readmegen . --format txt
readmegen . --format rst

How It Works

1. Project Analysis - Scans your project structure, dependencies, and code patterns
2. Type Detection - Identifies if it's a CLI tool, web app, API, or library
3. Smart Generation - Uses AI or intelligent templates to create relevant documentation
4. Professional Output - Generates clean, structured READMEs with proper sections

Supported Project Types

| Language | Frameworks Detected | Features Generated | |------------|-------------------------------|-------------------| | JavaScript | React, Vue, Express, Next.js | Component docs, API endpoints | | Python | Django, Flask, FastAPI | Virtual env setup, pip install | | Rust | Cargo projects | Cargo commands, performance notes | | Go | Go modules | Go build instructions | | Java | Maven, Gradle | Build tool commands |

Configuration

Environment Variables

# Required for AI features
export OPENAI_API_KEY="your-api-key-here"

# Optional: Use different AI model
export OPENAI_MODEL="gpt-5"

Template Mode

If you don't have an OpenAI API key, the tool automatically falls back to intelligent templates that still produce excellent results.

Examples

CLI Tool Output

# my-cli-tool
A Node.js command-line application for project automation.

## Installation
npm install -g my-cli-tool

## Usage
readmegen --help

Web App Output

# my-react-app
Modern React web application with component-based architecture.

## Installation
npm install
npm run dev

# Open http://localhost:3000

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

MIT

Links

• GitHub Repository
• NPM Package
• Report Issues

Made with care for developers who want better documentation