SuperAPI AI 工具集
合作ENAI 行业资讯收藏
全部工具AI办公工具readme-ai

readme-ai

ReadmeAI 是一款由 AI 驱动的 README 文件自动生成工具。用户只需提供代码仓库的 URL 或本地路径，它就能结合仓库处理引擎和语言模型，自动生成结构清晰、内容详细的 README 文档。工具支持 OpenAI、Ollama、Anthropic、Gemini 等多种 LLM 服务，也可在离线模式下不使用 LLM API 服务运行。它提供模板、样式、徽章等多种定制选项，具备智能文件过滤能力（通过 .readmeaiignore 模式），并且语言无关，兼容多种编程语言和框架。需要 Python 3.10 或更高版本，可通过 pip、pipx、uv、Docker 等方式安装。

访问官网

工具介绍

ReadmeAI 是一款开发者工具，利用仓库处理引擎和先进的语言模型自动生成 README 文件。只需提供代码库的 URL 或路径，即可生成结构良好且内容详尽的 README。它旨在简化所有技术领域和不同经验水平的文档创建与维护流程。

核心原则与用途：

  • 自动化：用单条命令生成详细且结构化的 README 文件。
  • 可定制：可从多种模板、样式、徽章等选项中选择。
  • 灵活性：可随时在 OpenAI、Ollama、Anthropic 和 Gemini 之间切换。
  • 语言无关：兼容多种语言和框架。
  • 最佳实践：确保所有项目的文档干净且一致。
  • 智能过滤：通过可定制的 .readmeaiignore 模式进行智能文件分析。
  • 离线模式：无需使用 LLM API 服务即可离线创建 README 文件。

生成的内容板块包括：项目介绍（捕捉项目精髓和价值主张）、详细的功能分解和技术能力、项目结构（用纯 Python 生成的目录树嵌入代码块，并总结关键模块作为后续提示的上下文，文件为 .toml）、快速入门指南（在预处理期间从代码库中提取依赖和系统需求，由解析器完成主要处理）、安装/使用/测试（基于从代码库提取的数据自动创建）、社区与支持（开发路线图、贡献指南、许可证信息、社区资源，并包含返回按钮）、贡献指南（包括资源链接和基本贡献指南，开源项目还会包含贡献者图表）。

安装要求：需要 Python 3.10 或更高版本。支持多种安装方式：

  • 用 pip 安装（对大多数用户推荐）： pip install readmeai
  • 用 pipx 安装（会在隔离环境中安装）： pipx install readmeai
  • 用 uv 安装（最快）： uv pip install readmeai
  • 用 Docker：从 Docker Hub 拉取最新镜像运行容器。
  • 从源码安装： git clone https://github.com/eli64s/readme-ai cd readme-ai pip install -r setup/requirements.txt 或运行安装脚本：bash setup/setup.sh 或用 poetry 安装：poetry install

可选依赖（用于 Anthropic 和 Google Gemini 客户端）：

  • Anthropic：pip install "readmeai[anthropic]"
  • Google Gemini：pip install "readmeai[google-generativeai]"
  • 同时安装多个：pip install "readmeai[anthropic,google-generativeai]"

使用方式：使用第三方服务时必须提供有效的 API key。例如 OpenAI 客户端需设置 API key。运行 Ollama 需先拉取模型并启动服务器： ollama pull llama3.2:latest export OLLAMA_HOST=127.0.0.1 && ollama serve Anthropic 需导出 API key：export ANTHROPIC_API_KEY=<your_api_key> Google Gemini 需导出：export GOOGLE_API_KEY=<your_api_key>

使用 OpenAI 客户端运行的最小命令示例： readmeai --repository https://github.com/eli64s/readme-ai --api openai 默认模型为 gpt-3.5-turbo，在使用 gpt-4 及以上系列模型时需注意监控成本。 切换到 Anthropic 客户端： readmeai --repository https://github.com/eli64s/readme-ai --api anthropic 切换到 Google Gemini 客户端： readmeai --repository https://github.com/eli64s/readme-ai --api gemini 使用本地 Ollama 模型： readmeai --repository https://github.com/eli64s/readme-ai --api ollama 从本地代码库生成 README，提供项目完整路径即可。可添加更多定制选项。支持离线模式，无需 LLM API 服务。也可在 Docker 容器中运行 CLI。可在 Streamlit Cloud 上直接在浏览器中试用（无需安装），但该 Web 应用可能不总是与最新功能同步，建议使用 CLI 获取最新功能。

从源码安装后的运行：

  • 若用 bash 脚本安装，先激活虚拟环境：conda activate readmeai，再运行：python3 -m readmeai.cli.main -r https://github.com/eli64s/readme-ai
  • 若用 poetry：poetry shell，再运行：poetry run python3 -m readmeai.cli.main -r https://github.com/eli64s/readme-ai

开发与测试使用 pytest 和 nox 框架。用 uv 安装依赖并用 pytest 运行单元测试；用 nox 在 Python 3.10、3.11、3.12、3.13 上测试应用。

查看所有可用选项：运行 readmeai --help。

官方文档提供完整的配置和定制指南。项目还提供示例画廊，展示各种编程语言、框架和项目类型生成的 README 示例。

项目路线图包括：发布 readmeai 1.0.0；扩展对各种项目类型和编程语言的模板支持；开发 VSCode 扩展以在编辑器中直接生成 README；开发 GitHub Actions 自动更新文档；添加徽章包提供更多徽章样式和选项（代码覆盖率、CI/CD 状态、项目版本等）。

许可证：MIT license。Copyright © 2023-2025 readme-ai。

同类工具

查看分类