OpenWiki：CLI工具，用于为你的代码库编写和维护代理文档

Hacker News Top 工具
cli documentation agents codebase open-source langchain

摘要

OpenWiki是LangChain的一个CLI工具，可自动生成和维护代码库的文档，专为AI代理设计。它支持多个推理提供商，并可与GitHub Actions集成以实现每日更新。

暂无内容
查看原文
查看缓存全文

缓存时间: 2026/07/01 23:03

langchain-ai/openwiki

源仓库：https://github.com/langchain-ai/openwiki

OpenWiki

OpenWiki 是一个 CLI 工具，专为智能体构建，用于编写和维护代码库的文档。

OpenWiki

安装

npm install -g openwiki

快速开始

初始化 OpenWiki，配置模型和 API 密钥，然后生成文档。

openwiki --init

接着，为了确保文档始终最新，可以将 GitHub Action 添加到仓库中，使其每天自动打开一个包含文档更新的 PR：openwiki-update.yml

将上述文件的内容复制到仓库的 .github/workflows/openwiki-update.yml 中。

用法

启动交互式 CLI：

openwiki

带初始请求启动 OpenWiki：

openwiki "请为这个仓库生成文档"

运行单个命令后退出：

openwiki -p "总结你能做什么"

初始化 OpenWiki：

openwiki --init

更新现有文档：

openwiki --update

显示帮助：

openwiki --help

当 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！

相似文章