eli64s/readme-ai

Health v2 · maintenance only

Adoption not part of the score

2979 stars · 296 forks observed · 2026-08-28

What it is AI-extracted, prompt v1, taxonomy v1, 2026-08-29, confidence not recorded

ReadmeAI is a Python CLI tool that automatically generates README.md files for any codebase using large language models. It supports multiple LLM backends (OpenAI, Anthropic, Gemini, Ollama) and offers customizable templates, badges, and styling options.

Use cases

• generate a readme for my github repo
• automatically create markdown documentation from a codebase
• bootstrap a professional README with badges and headers
• generate project documentation using an LLM
• create readme files for projects in any programming language
• document a repository with a local LLM via ollama

When to choose

• you want to quickly scaffold a polished README for a new or existing repository
• you want AI-generated project summaries, installation steps, and usage sections
• you need language-agnostic documentation generation across many repos
• you prefer flexible LLM backends including local models via Ollama

When to avoid

• you need hand-crafted, deeply reviewed documentation rather than AI-generated drafts
• you cannot or do not want to send code context to an LLM provider
• you need full API reference docs rather than a README overview

Facets

cli-tool · maturity active

documentation llm-inference cli markdown developer-tools documentation artificial-intelligence python cli cross-platform readme-generator ai-documentation badge-generator openai anthropic gemini ollama

Member repositories

For agents

markdown · JSON · MCP: product_card(name="eli64s/readme-ai")