📝 readme-ai

AI generates a README from your codebase. Point at a repo, get docs.

Install

npm install -g readme-ai

Usage

cd your-project
readme-ai

The AI analyzes your code structure, package.json, and main files to generate a complete README.

Examples

# Generate to stdout
readme-ai

# Write to file
readme-ai --output README.md
readme-ai -o README.md

# Specific project path
readme-ai ~/projects/my-app

# Different styles
readme-ai --minimal    # Brief: title, install, usage
readme-ai --detailed   # Full: badges, API docs, contributing

Styles

Style	Sections
--minimal	Title, description, install, usage
(default)	Title, description, features, install, usage, license
--detailed	Everything + badges, API, examples, contributing

What It Analyzes

• 📦 package.json - name, description, scripts, dependencies
• 📁 File structure - detects languages, main entry points
• 📄 Main files - reads entry points for context
• 🔧 Config files - detects TypeScript, testing frameworks

Example Output

# my-awesome-cli

A CLI tool that does awesome things.

## Features

- ⚡ Fast and lightweight
- 🔧 Easy configuration
- 📦 Zero dependencies

## Installation

\`\`\`bash
npm install -g my-awesome-cli
\`\`\`

## Usage

\`\`\`bash
my-awesome-cli [options]
\`\`\`

## License

MIT

AI Providers

export OPENAI_API_KEY=sk-...
export ANTHROPIC_API_KEY=sk-ant-...
# Or run Ollama locally

License

MIT