The last README you'll ever write by hand.

AI-powered README generation — for every language, framework, and developer.

❯ pip install readmeai && readmeai --api openai -r https://github.com/your/project
  ✓  README.md generated in 12.3s

🚀 Quickstart · ✨ Features · ⚙️ Configuration · 🖼 Gallery · 🤝 Contributing

ReadmeAI scans your entire codebase — local directory or remote URL — and generates a beautifully structured, production-quality README.md in seconds, powered by state-of-the-art language models.

No blank-page paralysis. No boilerplate copy-paste. No documentation debt.

🎯 Designed for simplicity, customization, and developer productivity.

Every element of your README is yours to control — headers, badge colors and styles, logos, emoji packs, and navigation layouts. Ship docs that match your project's personality.

Style	Preview	CLI Flag
Classic		--header-style classic
Modern		--header-style modern
Compact		--header-style compact
Console		--header-style console
SVG Banner		--header-style banner

Switch between the world's leading LLMs with a single flag. Or run entirely offline.

ReadmeAI produces complete, professional documentation sections — not templates, not stubs.

Control exactly which files ReadmeAI analyzes. Same syntax as .gitignore — add patterns to exclude generated files, vendor directories, or anything you don't want documented.

Choose your install method:

# pip — recommended for most users
❯ pip install -U readmeai

# pipx — keeps readmeai isolated from other projects
❯ pipx install readmeai

# uv — fastest install available
❯ uv tool install readmeai

# Docker — zero-dependency, runs anywhere
❯ docker pull zeroxeli/readme-ai:latest

❯ git clone https://github.com/eli64s/readme-ai
❯ cd readme-ai
❯ pip install -r setup/requirements.txt

# Or with Poetry:
❯ poetry install

# Or with the setup script:
❯ bash setup/setup.sh

Note — Anthropic or Gemini users: install the provider extras:

pip install "readmeai[anthropic]"
pip install "readmeai[google-generativeai]"
pip install "readmeai[anthropic,google-generativeai]"

# OpenAI
❯ export OPENAI_API_KEY=<your_key>

# Anthropic
❯ export ANTHROPIC_API_KEY=<your_key>

# Google Gemini
❯ export GOOGLE_API_KEY=<your_key>

# Ollama — no key needed, just start the server
❯ export OLLAMA_HOST=127.0.0.1 && ollama serve

Minimal — start here:

❯ readmeai --api openai -r https://github.com/your/project

Switch providers in seconds:

# Anthropic Claude
❯ readmeai --api anthropic -m claude-3-5-sonnet-20240620 -r https://github.com/your/project

# Google Gemini
❯ readmeai --api gemini -m gemini-1.5-flash -r https://github.com/your/project

# Local Ollama (free, private)
❯ readmeai --api ollama --model llama3.2 -r https://github.com/your/project

# Fully offline — no AI, no internet
❯ readmeai --api offline -r https://github.com/your/project

Full customization — power user mode:

❯ readmeai \
    --repository https://github.com/your/project \
    --api openai \
    --model gpt-4 \
    --output my-readme.md \
    --badge-color A931EC \
    --badge-style flat-square \
    --header-style compact \
    --navigation-style fold \
    --logo LLM \
    --emojis solar \
    --temperature 0.9 \
    --tree-depth 2

Docker:

❯ docker run -it --rm \
    -e OPENAI_API_KEY=$OPENAI_API_KEY \
    -v "$(pwd)":/app zeroxeli/readme-ai:latest \
    --repository https://github.com/your/project \
    --api openai

⚠️ The Streamlit app may lag behind the CLI on the latest features. Use the CLI for cutting-edge functionality.

# Install dev + test dependencies
❯ uv pip install --dev --group test --all-extras

# Run the unit test suite
❯ make test

# Test across Python 3.9 / 3.10 / 3.11 / 3.12 via nox
❯ make test-nox

All options are available as CLI flags. Every single one has a sensible default — customize only what you need.

❯ readmeai --help   # full reference

📚 Full Documentation →

ReadmeAI-generated READMEs across a wide range of real-world projects:

💬 Generated something great? Share it in Show & Tell →

• readmeai v1.0.0 — stable, production-ready release with robust docs creation
• Extended templates for more project types and programming languages
• VS Code Extension — generate READMEs directly inside your editor
• GitHub Actions integration — automatically update docs on every push
• Badge packs — code coverage, CI status, version, and more

ReadmeAI is open source and community-driven. All contributions are welcome.

• 📖 Contributing Guide — workflow, coding standards, PR process
• 🐛 Report a Bug — something broken? let us know
• 💡 Start a Discussion — ideas, questions, feedback

Built on the shoulders of excellent open-source projects:

Copyright © 2023–2025 ReadmeAI. Released under the MIT License.