readme-ai

readme-ai is a Python command-line tool that generates complete, structured README files by analyzing a local or remote code repository and passing the results through a large language model. Users run a single `readmeai` command with a repository URL or file path, and the tool produces a markdown document with sections covering project overview, features, installation, usage, and more. It supports multiple AI backends including Anthropic Claude, OpenAI, Google Gemini, and Ollama, letting users switch providers via a single flag. Badge style, badge color, header layout, logo, and table-of-contents format are all configurable through CLI arguments, and a `.readmeaiignore` file allows selective exclusion of repository files from analysis. An offline mode generates README output without any API calls. The tool connects to Anthropic through the standard API rather than Claude Code or MCP. Developers who maintain multiple repositories or who dislike writing documentation manually are the primary audience, and the project has accumulated over 2,900 stars on GitHub.

Deploy readme-ai to your cloud

Ship this repo to production in minutes. Each platform spins up its own environment with editable env vars.

Maintain this repo? Add a badge to your README

Drop the badge into your GitHub README to show it's tracked on ClaudeWave. Each badge links back to this page and reflects the live Trust Score.

Markdown (README)Copy

[![Featured on ClaudeWave](https://claudewave.com/api/badge/eli64s-readme-ai)](https://claudewave.com/repo/eli64s-readme-ai)

HTMLCopy

<a href="https://claudewave.com/repo/eli64s-readme-ai"><img src="https://claudewave.com/api/badge/eli64s-readme-ai" alt="Featured on ClaudeWave: eli64s/readme-ai" width="320" height="64" /></a>