Repolode
提交项目
eli64s

eli64s/readme-ai

一款命令行工具，可借助大语言模型为代码仓库自动生成 README 文件，也支持无需 API 的离线模式。

在 GitHub 查看官网
Star
3,005
Fork
296
未关闭 Issue
61
最近提交
3天前

这是什么？

ReadmeAI 是一款命令行工具，通过分析代码仓库自动生成 README 文件。你可以提供 GitHub、GitLab、Bitbucket 的仓库地址或本地目录路径，工具会提取项目结构、依赖和使用方式等信息，生成结构化的文档。

它支持 OpenAI、Anthropic、Google Gemini 等多家大模型服务，也可通过 Ollama 调用本地模型。离线模式无需调用任何 LLM 接口即可生成 README。输出样式可通过参数调整，包括标题与导航样式、徽章颜色和样式、Logo、表情符号主题以及目录树深度。项目根目录下的 .readmeaiignore 文件可控制哪些文件参与分析。

该工具可通过 PyPI 或 Docker 镜像安装，也支持从源码运行，适合希望快速为项目建立或更新文档的开发者。

核心功能

  • 01支持从 GitHub、GitLab、Bitbucket 仓库地址或本地目录生成 README。
  • 02可选 OpenAI、Anthropic、Google Gemini 和 Ollama 作为大模型服务。
  • 03提供无需 LLM 接口的离线模式。
  • 04通过命令行参数自定义标题、导航、徽章、Logo 和表情符号。
  • 05支持使用 .readmeaiignore 文件排除不需要分析的文件。

适用场景

  • 为缺少文档的新项目快速生成 README。
  • 批量更新多个仓库中过时的 README。
  • 借助 Ollama 本地模型为私有代码库生成文档。

快速上手

  1. 1

    按照 README 中的快速开始部分安装 ReadmeAI

  2. 2

    传入仓库 URL 为该仓库生成 README

    readmeai --repository https://github.com/eli64s/readme-ai

使用前须知

  • 使用 LLM 生成内容需要 OpenAI、Anthropic、Gemini 等服务商的 API 密钥，或自行配置本地 Ollama。

收录于专题

开源 AI Agent 框架与应用命令行与终端工具静态网站生成器与文档工具

标签

#readme#documentation#cli#llm#markdown#developer-tools#agents#ai#ai-agents#ai-documentation

常见问题

readme-ai 是什么？
一款命令行工具，可借助大语言模型为代码仓库自动生成 README 文件，也支持无需 API 的离线模式。 ReadmeAI 是一款命令行工具，通过分析代码仓库自动生成 README 文件。你可以提供 GitHub、GitLab、Bitbucket 的仓库地址或本地目录路径，工具会提取项目结构、依赖和使用方式等信息，生成结构化的文档。
readme-ai 可以免费使用吗？用的什么许可证？
readme-ai 以 MIT 许可证开源。用于商业产品前，请先确认许可证条款。
readme-ai 还在维护吗？
活跃维护中。readme-ai 最近一次提交是在 2026年11月4日。
readme-ai 适合用来做什么？
为缺少文档的新项目快速生成 README。 批量更新多个仓库中过时的 README。 借助 Ollama 本地模型为私有代码库生成文档。
readme-ai 怎么安装和运行？
按照 README 中的快速开始部分安装 ReadmeAI 传入仓库 URL 为该仓库生成 README: readmeai --repository https://github.com/eli64s/readme-ai
在哪里获取 readme-ai？
源代码和安装说明在 GitHub 上：https://github.com/eli64s/readme-ai

概要由 AI 根据项目 README 生成；GitHub 数据每日更新。

相关项目