OpenWiki:为你的代码库编写和维护代理文档的 CLI
OpenWiki 是一个为你的代码库编写和维护文档的 CLI,专门为代理而构建。 安装 npm install -g openwiki 快速开始 初始化 OpenWiki,配置你的模型和 API 密钥,然后生成文档 openwiki --init 为了确保你的文档保持最新,添加 GitHub 操作到你的代码库,以便每天自动打开一次 PR 进行文档更新: openwiki-update.yml 将该文件的内容复制到你的代码库中的 .github/workflows/openwiki-update.yml。 用法 启动交互式 CLI: openwiki 使用初始请求启动 OpenWiki: openwiki "请为此代码库生成文档" 运行单个命令然后退出: openwiki -p "总结你能做的事情" 初始化 OpenWiki: openwiki --init 更新现有文档: openwiki --update 显示帮助信息: openwiki --help 当没有wiki存在时,openwiki会在openwiki/中创建初始文档。如果openwiki/已经存在,它将根据代码库的更改刷新该文档。默认情况下,CLI 在每次运行后保持打开状态,以便你可以发送后续消息。使用 -p 或 --print 进行一次性非交互运行,打印最终的助手输出。openwiki 会自动将提示附加到你的 AGENTS.md 和/或 CLAUDE.md 文件中,以指示你的编码代理在搜索上下文时参考它。如果该文件在你的代码库中不存在,OpenWiki 会为你创建它。在第一次交互运行时,OpenWiki 会让你配置你的推理提供者、API 密钥和 LLM。你还可以设置一个 LangSmith API 密钥,以将你的 OpenWiki 运行追踪到名为 "openwiki" 的 LangSmith 追踪项目(可选)。这些配置选项和密钥将保存在你的本地计算机的 ~/.openwiki/.env 中。 自定义 OpenWiki 原生支持 OpenRouter、Fireworks、Baseten、OpenAI 和 Anthropic。默认情况下,有一些预定义的模型(GLM 5.2、Kimi K2.6、Sonnet 5 等),但对于每个推理提供者,OpenWiki 允许你指定自己的自定义模型 ID。如果你想看到添加某个推理提供者或模型,请打开一个 PR!
本站免费、广告极少。如果觉得有帮助,可以请我们喝杯咖啡 —— 任何金额都对持续运营有实际帮助。
☕请我喝杯咖啡