> ## Documentation Index
> Fetch the complete documentation index at: https://docs.qoder.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 生成仓库 Wiki（RepoWiki）

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

# 生成仓库 Wiki

RepoWiki 通过 `qodercli wiki` 子命令，为你的代码仓库在**本地生成 wiki 文档**。整个生成过程在本地完成，代码不出域。

`wiki` 是一个**外部命令**：它不随主程序打包，而是在首次使用时按需从官方分发源下载对应平台的工具并安装到本地，之后直接在本机运行。

# 前提条件

* 已完成登录认证。`wiki` 命令需要认证信息，可通过 `qodercli` 登录或设置 `QODER_PERSONAL_ACCESS_TOKEN` 提供，详见[登录与认证](https://docs.qoder.com/zh/cli/01-开始使用/auth.md)。
* 首次使用需要网络，以便下载 wiki 工具（仅下载工具本身，不上传代码）。

# 快速开始

在目标仓库根目录下运行：

```bash theme={null}
qodercli wiki
```

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

# 传递参数

`wiki` 之后的所有参数会**原样透传**给底层 wiki 工具：

```bash theme={null}
qodercli wiki [该工具支持的参数...]
```

底层工具支持哪些参数（如输出位置、语言等）由工具自身定义。请以其帮助信息为准：

```bash theme={null}
qodercli wiki --help
```

# 指定工作目录

默认对当前工作目录（`process.cwd()`）所在的仓库生成 wiki。如需指定其他目录，在 `wiki` **之前**使用 `--cwd` 或 `--workspace`：

```bash theme={null}
qodercli --cwd /path/to/repo wiki
qodercli --workspace /path/to/repo wiki
```

注意位置：工作目录参数放在 `wiki` 之前由 CLI 解析；放在 `wiki` 之后的参数会被透传给底层工具。

# 安装与版本管理

`wiki` 工具通过 CLI 的外部命令机制管理，你可以用 `qodercli external` 系列子命令显式操作：

```bash theme={null}
qodercli external list              # 列出可用的外部命令及安装状态
qodercli external update wiki       # 安装或更新 wiki 到目标版本（别名：install）
qodercli external remove wiki       # 移除已安装的 wiki
```

安装内容位于全局配置目录下的 `external-commands/wiki/`，按版本目录保留。

# 代码不出域

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

# 网络与代理

下载工具时会走系统网络设置。CLI 会将常见的代理与证书环境变量透传给外部命令，包括 `HTTP_PROXY`、`HTTPS_PROXY`、`NO_PROXY`、`NODE_EXTRA_CA_CERTS` 等。受限网络环境下的排查见网络问题排查。

如需自定义或禁用注册表来源，可用以下环境变量：

* `QODER_EXTERNAL_COMMAND_REGISTRY_URL`——覆盖注册表 URL；设为 `off`/`none`/`false`/`0` 可禁用远程刷新。
* `QODER_EXTERNAL_COMMAND_REGISTRY_FILE`——从本地文件加载注册表。

# 常见问题

**输入 `qodercli wiki` 提示无此命令？**
确认 CLI 已更新到最新版本（旧版本可能不包含该命令），可运行 `qodercli --help` 查看 `wiki` 是否在命令列表中。

**认证失败？**
确认已登录，或已正确设置 `QODER_PERSONAL_ACCESS_TOKEN`（注意令牌前后不要带空格）。详见登录问题排查。

**首次运行下载失败？**
检查网络与代理设置，必要时配置上述代理环境变量后重试；如需调整注册表来源，可用 `QODER_EXTERNAL_COMMAND_REGISTRY_URL` / `QODER_EXTERNAL_COMMAND_REGISTRY_FILE` 环境变量（见上文）。

**如何更新 wiki 工具版本？**
用 `qodercli external update wiki` 更新到最新版本。

# 下一步

* 登录与令牌：[登录与认证](https://docs.qoder.com/zh/cli/01-开始使用/auth.md)。
* 网络与代理配置：网络与代理。
* 命令行启动参数：CLI 启动参数参考。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.