Skip to main content
开始一个任务

生成仓库 Wiki

qoderclicn wiki 在本地为仓库生成结构化 Wiki;作为外部命令按需下载,全程离线、代码不出域

生成仓库 Wiki

wiki 命令当前在 Qoder CLI CN 版本中暂未开放,运行 qoderclicn wiki 会提示无此命令。本页内容供提前了解功能,待 CN 版开放后即可按此使用。
RepoWiki 通过 qoderclicn wiki 子命令,为你的代码仓库在本地生成 wiki 文档。整个生成过程在本地完成,代码不出域。 wiki 是一个外部命令:它不随主程序打包,而是在首次使用时按需从官方分发源下载对应平台的工具并安装到本地,之后直接在本机运行。

前提条件

  • 已完成登录认证。wiki 命令需要认证信息,可通过 qoderclicn 登录或设置 QODERCN_PERSONAL_ACCESS_TOKEN 提供,详见登录与认证
  • 首次使用需要网络,以便下载 wiki 工具(仅下载工具本身,不上传代码)。

快速开始

在目标仓库根目录下运行:
qoderclicn wiki
首次运行时,CLI 会自动完成下载与安装,然后开始为当前目录的仓库生成 wiki。

传递参数

wiki 之后的所有参数会原样透传给底层 wiki 工具:
qoderclicn wiki [该工具支持的参数...]
底层工具支持哪些参数(如输出位置、语言等)由工具自身定义。请以其帮助信息为准:
qoderclicn wiki --help

指定工作目录

默认对当前工作目录(process.cwd())所在的仓库生成 wiki。如需指定其他目录,在 wiki 之前使用 --cwd--workspace
qoderclicn --cwd /path/to/repo wiki
qoderclicn --workspace /path/to/repo wiki
注意位置:工作目录参数放在 wiki 之前由 CLI 解析;放在 wiki 之后的参数会被透传给底层工具。

安装与版本管理

wiki 工具由 CLI 的外部命令机制自动管理:首次使用 qoderclicn wiki 时按需下载安装到本地,并按远程注册表获取版本,无需手动安装或更新。 安装内容位于全局配置目录下的 external-commands/wiki/,按版本目录保留。如需自定义或禁用注册表来源,见下文网络与代理中的环境变量。

代码不出域

wiki 的生成是本地行为:下载安装完成后,wiki 工具在本机文件系统上读取仓库并生成文档,不会上传仓库代码。网络仅用于下载工具本身以及必要的认证。

网络与代理

下载工具时会走系统网络设置。CLI 会将常见的代理与证书环境变量透传给外部命令,包括 HTTP_PROXYHTTPS_PROXYNO_PROXYNODE_EXTRA_CA_CERTS 等。受限网络环境下的排查见网络、代理与 VPC 问题 如需自定义或禁用注册表来源,可用以下环境变量:
  • QODER_EXTERNAL_COMMAND_REGISTRY_URL——覆盖注册表 URL;设为 off/none/false/0 可禁用远程刷新。
  • QODER_EXTERNAL_COMMAND_REGISTRY_FILE——从本地文件加载注册表。
注意:这两个变量不区分版本,CN 版同样使用 QODER_ 前缀(而非 QODERCN_)。

常见问题

输入 qoderclicn wiki 提示无此命令? 该命令当前在 CN 版本中暂未开放(见页首提示),属预期行为;开放后更新 CLI 到最新版本即可使用,可运行 qoderclicn --help 查看 wiki 是否已在命令列表中。 认证失败? 确认已登录,或已正确设置 QODERCN_PERSONAL_ACCESS_TOKEN(注意令牌前后不要带空格)。详见登录与认证问题 首次运行下载失败? 检查网络与代理设置,必要时配置上述代理环境变量后重试;如需调整注册表来源,可用 QODER_EXTERNAL_COMMAND_REGISTRY_URL / QODER_EXTERNAL_COMMAND_REGISTRY_FILE 环境变量(见上文)。 如何更新 wiki 工具版本? wiki 版本由外部命令机制按远程注册表自动获取,通常无需手动操作;如需控制注册表来源或禁用远程刷新,可用上文的 QODER_EXTERNAL_COMMAND_REGISTRY_URL / QODER_EXTERNAL_COMMAND_REGISTRY_FILE 环境变量。

下一步