readme-ai
README file generator, powered by AI.
- 3k stars
- 296 forks
- 60 open issues
- Language: Python
- License: MIT
- updated
Install
git clone https://github.com/eli64s/readme-ai && cp readme-ai/*.md ~/.claude/agents/- Clone the repository and copy the agent .md definitions into ~/.claude/agents (or .claude/agents inside a project).
- Start a new Claude Code session to load the agents.
- Delegate work to them with the Task/Agent tool or by name.
Editor's note
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.
Subagents overview
What people ask about readme-ai
What is eli64s/readme-ai?
eli64s/readme-ai is subagents for the Claude AI ecosystem. README file generator, powered by AI. It has 3k GitHub stars and its last recorded update is dated 2026-10-14.
How do I install readme-ai?
You can install readme-ai by cloning the repository (https://github.com/eli64s/readme-ai) or following the README instructions on GitHub. ClaudeWave also provides quick install blocks on this page.
Is eli64s/readme-ai safe to use?
Our security agent has analyzed eli64s/readme-ai and assigned a Trust Score of 100/100 (tier: Verified). See the full breakdown of passed checks and flags on this page.
Who maintains eli64s/readme-ai?
eli64s/readme-ai is maintained by eli64s. The last recorded GitHub activity is dated 2026-10-14, with 60 open issues.
Are there alternatives to readme-ai?
Yes. On ClaudeWave you can browse similar subagents at /categories/agents, sorted by popularity or recent activity.