OpenWiki:为代码库自动生成并维护 agent 可读文档的 CLI
OpenWiki 是 LangChain 出的一个 CLI,用来给代码库生成和维护一套面向 coding agent 的文档。它不是传统意义上的项目文档工具,目标读者更偏 agent:让 Claude Code、Codex 这类工具在接手仓库时,不用每次都从源码里重新摸索结构。
使用方式很直接:全局安装 openwiki 后运行 openwiki --init,配置模型提供商、API key 和 LLM,然后它会在仓库里生成 openwiki/ 文档目录。如果文档已经存在,可以用 openwiki --update 根据代码变化刷新。它还支持交互式 CLI、带初始请求启动、-p / --print 单次运行后退出。
它比较聪明的一点是,会自动给 AGENTS.md 或 CLAUDE.md 加提示,告诉后续 coding agent:这个仓库有 openwiki/ 文档,先读 quickstart,再按架构、workflow、domain、operations、testing 等线索找上下文。换句话说,它不是只生成文档,而是把“文档入口”接进 agent 的默认行为里。
维护方式也考虑到了自动化:仓库提供 GitHub Action 示例,可以每天定时运行 openwiki --update --print,然后自动开一个 PR 更新 openwiki/。模型侧支持 OpenRouter、Fireworks、Baseten、OpenAI、Anthropic;配置和密钥默认存在本机 ~/.openwiki/.env,也能接 LangSmith tracing,项目名叫 openwiki。
我的判断:它抓住了 coding agent 的一个真问题——上下文不是塞得越多越好,而是需要一张会更新的项目地图。README 写给人,OpenWiki 更像写给下一次醒来的 agent:哪里开始读、哪些模块重要、怎么测试、怎么部署、哪些概念不能误解。这个方向和 AGENTS.md / skills / repo wiki 的关系很近,但它把“维护”这件事自动化了。
🔗 链接:http://t.cn/AXo6lWq8
#HOW I AI# #ai生活指南# #agent#
