使用 qodercli wiki 分析代码仓库并生成结构化 Wiki 文档。
生成仓库 Wiki
RepoWiki 通过 qodercli wiki 命令分析代码仓库并生成结构化 Wiki 文档。
前提条件
- 已完成登录认证。你可以通过
qodercli登录,或设置QODER_PERSONAL_ACCESS_TOKEN,详见登录与认证。 - 当前设备可以访问 Qoder 服务。首次运行需要准备 Wiki 组件,生成 Wiki 时也需要网络连接。
快速开始
在目标仓库根目录下运行:
常用选项
| 选项 | 说明 |
|---|---|
--repo <path> | 目标仓库路径。可多次指定,以处理多个仓库。 |
--language <languages> | 逗号分隔的输出语言,例如 zh,en。 |
--branch <branch> | 要处理的 Git 分支。省略时使用当前 HEAD 分支。 |
--regenerate | 从头重新生成,并删除已有的可复用 Wiki 数据。 |
--help | 查看当前 Wiki 组件支持的选项。 |
wiki 之后的选项会传递给 Wiki 组件。运行 qodercli wiki --help 可以查看当前版本支持的完整选项。
指定工作目录
默认使用当前工作目录。如需在 Qoder CLI 层指定其他工作区,请将 --cwd 或 --workspace 放在 wiki 之前:
wiki 之后使用 --repo,指定一个或多个目标仓库。
网络与代理
运行 RepoWiki 时,Qoder CLI 会传递常见的代理与证书环境变量,包括 HTTP_PROXY、HTTPS_PROXY、ALL_PROXY、NO_PROXY 和 NODE_EXTRA_CA_CERTS。
如果在受限网络环境中遇到组件准备、自动更新、认证或 Wiki 生成失败,请检查代理和证书配置。详见网络、代理与 VPC 问题。
常见问题
为什么找不到 qodercli wiki 命令?
请将 Qoder CLI 更新到最新版本,确认网络连接正常,然后重新运行 qodercli --help。
为什么认证失败?
确认已登录,或已正确设置 QODER_PERSONAL_ACCESS_TOKEN。详见登录与认证问题。
为什么组件准备或自动更新失败?
检查网络、代理和证书配置,然后重新运行 qodercli wiki。如果本地已有可用版本,版本检查暂时不可用时,Qoder CLI 可以继续使用该版本。
如何更新 Wiki 组件?
直接运行 qodercli wiki。Qoder CLI 会自动检查并应用官方支持的版本。
如何完全重新生成已有 Wiki?
运行 qodercli wiki --regenerate。生成前会删除已有的可复用 Wiki 数据。
下一步
- 登录与令牌:登录与认证。
- 网络与代理配置:网络、代理与 VPC。
- 命令行启动参数:CLI 命令与参数。