ai-wiki
v1.0.2
Published
AI Wiki CLI:分析项目并生成标准化Markdown Wiki,支持预览与校验
Readme
AI Wiki CLI
AI Wiki 命令行工具:分析项目结构与技术栈,生成标准化 Markdown Wiki(概览、接口、数据、测试、运维等),支持版本差异标注与本地预览。
安装
npm i -g ai-wiki或在项目内本地安装:
npm i -D ai-wiki使用
在项目根目录运行:
- 初始化文档骨架:
aiwiki init - 分析项目结构:
aiwiki analyze - 生成/更新 Wiki:
aiwiki generate - 校验完整性:
aiwiki validate --fix - 预览/静态导出:
aiwiki preview --port 8000或aiwiki preview --static - 调用 Gemini 测试:
aiwiki gemini -p "你的提示词" --stream --verbose
提示词文件:在项目根放置
提示词.MD可定制生成风格;默认使用内置提示词。
配置
在项目根创建 aiwiki.config.json:
{
"wiki": { "outputDir": "wiki" },
"ai": {
"geminiCliPath": "gemini",
"model": "gemini-1.5-pro",
"promptFile": "提示词.MD",
"timeoutMs": 8000
},
"preview": { "port": 8000 }
}更多字段请参考 src/lib/config.js 的默认值。
运行环境
- Node.js >= 18
- 可选:已安装
@google/gemini-cli并配置凭证
目录结构(发布包)
bin/aiwiki.js:CLI 入口src/commands/*.js:命令实现(init/generate/preview/analyze/diff/validate/gemini)src/lib/*.js:通用库(配置、发现、生成、渲染等)
示例项目与静态输出目录不会包含在发布包中(通过
files白名单控制)。
许可
ISC
