用途:为代码库生成参考文档(说明“是什么/怎么做”),不产出战略叙事(“为什么”)。适用于用户要求“document this codebase”“generate a wiki”“make architecture diagrams”、接手陌生仓库需要结构化参考、或指向 GitHub URL 请求文档时。不适用于单文件/单函数文档、单个 API 端点参考、战略叙事,或用户正在本会话中活跃开发的代码库。
主要能力:生成 README.md(概览与模块地图)、architecture.md(含 Mermaid flowchart)、modules/ 下逐模块文档、diagrams/class-diagram.md(Mermaid classDiagram)、diagrams/sequences.md(2–4 个工作流的 Mermaid sequenceDiagram)、getting-started.md,以及适用时的 api.md,并写入 .codewiki-state.json 状态文件。
使用方式:通过 terminal 工具在目标仓库根目录调用,再用 read_file / search_files / write_file 产出。默认输出到 ~/.hermes/wikis/<repo-name>/,仅在用户明确要求时才写入仓库内 docs/wiki/。GitHub URL 可用 git clone --depth 50 <url> 克隆到临时目录。前置条件:无需环境变量;git 需在 PATH 中;pygount 可选。
限制:初始扫描最大深度 3,逐模块文档默认上限 10 个模块;跳过 vendored 代码、生成代码与测试;Mermaid 图建议不超过约 20 个节点;不得虚构组件或调用,所有节点与函数调用须在源码中真实存在;GitHub Mermaid 主题固定,不要包含 %%{init: ...}%% 块。增量重生成目前为未来增强,当前可整体重新生成。