项目简介
ai2readme 是一个智能生成项目文档的工具，旨在提升开发效率。它能够自动整合项目内容并生成 Markdown 格式的 README 文档，支持多语言翻译和灵活的配置选项。
使用视频
请前往 ai2readme: 一个命令让 AI 根据分析你的项目自动生成 README 支持ollama, zhipuai (gitee.com) 查看
核心功能
自动生成 README
通过分析项目结构和关键代码片段，生成专业的中文 README 文档。支持从 package.json 中提取项目名称和主入口文件信息。
多语言翻译
提供将生成的 README 文档翻译为英文版本的功能，方便国际化协作。
多 AI 后端支持
支持智谱 AI（zhipu）云端服务和 Ollama 本地模型，用户可根据需求灵活选择。
命令行交互
提供 generate（生成）、translate（翻译）、help（帮助）等命令行操作，支持指定目标目录和配置文件。
使用方法
安装与运行
克隆仓库后全局安装依赖：
git clone https://github.com/AEJays/ai2readme.git
或
git clone https://gitee.com/aedge/ai2readme.git (gitee)
npm install -g .
生成 README
默认生成当前目录的文档：
ai2readme generate
指定目录和主文件：
ai2readme generate ./my-project src/index.js
翻译 README
将中文 README 翻译为英文：
ai2readme translate ./my-project
配置说明
环境变量文件 .env 示例：
AI_PROVIDER=zhipu
ZHIPU_API_KEY=<Your API Key>
ZHIPU_MODEL=glm-4.6v-flash
OLLAMA_BASE_URL=http://localhost:11434
OLLAMA_MODEL=<YourModel>
特性对比
| 特性 | 说明 |
|---|---|
| 多 AI 后端支持 | 兼容云端和本地模型，适应不同网络环境 |
| 自动忽略规则 | 默认排除 node_modules 等目录，减少无关文件分析 |
| 灵活配置 | 支持通过命令行参数或配置文件定制生成逻辑 |
注意事项
- 生成 GitHub 徽标需项目为开源仓库且已设置
git remote origin。 - 替换 AI 模型时需自行测试效果，尤其是本地模型（如 Ollama）。
