readme-ai
CLI that generates polished READMEs from any codebase using LLMs.
About
readme-ai is an open-source CLI that automatically generates README files from a codebase using large language models. Point it at a GitHub repository URL or a local directory and it produces a structured README with badges, navigation, and project overview, customizable by header style, badge style, and emoji theme.
It supports OpenAI, Anthropic, and Google Gemini APIs, runs against local models via Ollama, and includes an offline mode that works without any LLM service. Installable via pip, it fits naturally into documentation workflows for developers who want presentable READMEs without writing them by hand.
What it can do
- README generation from repo URLs or local codebases
- Multi-provider LLM support plus Ollama and offline mode
- Customizable headers, badges, and navigation styles
- One-command CLI workflow
- Open-source and pip-installable
Setup
Install with pip install readme-ai, export your provider API key, then run readmeai with a repository URL or path.
Prerequisites
Python, and an API key for OpenAI, Anthropic, or Gemini (or Ollama for local models).
Use cases
Works with
Trust score — 7/10
Scored 7/10 (metrics tier, metrics-v1). Evidence: Verified via vendor site/docs/GitHub and reputable coverage, wave 108; Trending score 68/100 from researcher assessment.
Sources
Every fact above was checked against these sources. Where a claim comes from the provider and couldn't be independently verified, the text says so.