ReadmeAI is a Python-based tool that generates README files from codebases using AI, with CLI options and template customization. It supports multiple LLM backends and offline mode, and has ongoing release updates.
Collecting history — the radar snapshots this repo daily. The trend line appears after 3 days of data (1 so far).
What it is
ReadmeAI is a developer tool that automatically generates README files using a robust repository processing engine and advanced language models. Simply provide a URL or path to your codebase, and a well-structured and detailed README will be generated.
How it works
The project supports switching between OpenAI, Ollama, Anthropic, and Gemini as LLM backends. It includes features for customizable templates, styles, badges, and more, with an offline mode option for generating README files without using a LLM API service. The README highlights intelligent file analysis with customizable ignore patterns and a CLI-driven workflow.
Getting started
Prerequisites:
- Python 3.9 or higher
- One of the installation methods described in the documentation (the README shows examples and CLI usage commands). The demo section provides a command:
readmeai-cli-demo
The Getting Started section in the README also covers configuration and initial usage details, including how to preprocess codebases and generate READMEs from repository URLs or local paths.
Recent releases
- v0.1.6 (2023-10-24): refactor: Reduce complexity of markdown table generator methods. @eli64s (#70); enhancement: Add more context to LLM prompts. @eli64s (#69); feat: Add CLI option --emojis to change
- v0.1.5 (2023-10-16): features including support for three badge icon styles, README-de, etc.
- v0.1.4 (2023-10-01): Add new SVG badge icons selectable via CLI
--badges; refactor readmeai package structure - v0.1.3 (2023-09-30): Setup script enhancement; decouple CLI as own directory
- v0.1.2 (2023-09-26): Implement custom tree generation method in pure Python
Traction
Stars: 2964; Forks: 292; Open issues: 69
Behind the repo
(not provided in the provided facts)
Caveats
License: MIT; Language: Python; Created: 2023-01-16; Last push: 2026-07-04