whereismyai
README AI
README AI is a CLI developer tool that automatically generates structured README files for code repositories using language models.
ReadmeAI processes repository codebases to generate detailed, well-structured README files. It analyzes the code to extract information for project introductions, feature tables, installation guides, and project structures. Users can customize the output with various templates, header styles, badges, and emojis. It supports integration with OpenAI, Anthropic, Google Gemini, and Ollama for model-based generation. An offline mode allows document creation without requiring an external API service.
README AI at a glance
- Best for: Software engineer
- Runs on: CLI, GitHub, GitLab, Bitbucket, File System
- Pricing: Free
- Released: January 2023
- Category: AI coding tool
- Website: github.com/eli64s/readme-ai
Key features
- Automated README generation from repository URLs or paths
- Customizable templates, badges, logos, and header styles
- Support for OpenAI, Anthropic, Google Gemini, and Ollama models
- Offline generation mode without LLM API services
- Intelligent code analysis with ignore pattern support
- Automatic generation of project structure trees
- Extraction of installation, dependency, and usage requirements
Use it for
- Generating documentation for new repositories
- Standardizing documentation style across projects
- Updating project READMEs with automated installation steps
- Creating open source project documentation
Companions
Tools that articles about README AI recommend using with it, each with its job.
- Context7 — Provides up-to-date documentation for AI agents and code editors.
- Ollama — Run local models at zero marginal cost, with code kept on your machine.
- OpenRouter — Access over 500 models and 80 providers through one unified API.
- Daytona — Runs sessions in isolated sandboxes synced to git branches.
- Composio — Equips AI agents with tools, managed user auth, and sandboxes across 1,500+ apps
- Oh My OpenCode Slim — Lightweight multi-agent orchestration and background tasks.
Alternatives to README AI
- Beautify Github Readme — It organizes repository content and creates project-native visual systems without templates.
- jevgrep — Reduces coding agent costs by providing targeted, relevant repository context.
- OpenCode — Works with 75+ model providers, local models, and existing subscriptions
- Repomix — Packages entire codebases into single files for AI context.
- CodeSight — Reduces AI token usage significantly and maps projects instantly.
- Codocly — Generates technical documentation automatically from source code.
- AGENTS.md — It separates agent-specific instructions from human-focused README files.
- opencode.nvim — Keeps AI interactions within the existing Neovim environment and workflow.
- DocuWriter.ai — Generates and maintains up-to-date documentation directly from code.
- ModLens — Converts screenshots and charts into structured JSON data for coding agents.
- Maige — Automates GitHub issue management and code reviews using natural language rules.
- opensrc — Provides AI agents direct access to package source code rather than types.
All README AI alternatives