---
url: /zh/ai/codewiki.md
description: 介绍如何配置 codewiki 流水线插件，自动根据代码仓库内容生成 Wiki 文档，快速构建文档中心。
---
配置 codewiki 流水线后，可按仓库代码自动生成 Wiki 文档。仓库首页将出现 Wiki 入口，方便快速构建文档中心。

![codewiki 入口](/images/ai/cnb-codewiki.png)

## 通过 NPC 生成

最快的方式是召唤 [npc/codewiki](https://cnb.cool/npc/codewiki) NPC 按需生成或更新 CodeWiki，
无需在自己的仓库中配置 `.cnb.yml`。

1. Star [npc/codewiki](https://cnb.cool/npc/codewiki) 仓库。

2. 在仓库的 Issue 或 Pull Request 评论区通过 `@npc/codewiki(codewiki)` 召唤 NPC，并在后面填写任务，例如：

   ```text
   @npc/codewiki(codewiki) 生成codewiki
   @npc/codewiki(codewiki) 更新codewiki
   ```

NPC 会执行环境检查、启动 CodeWiki 容器、跟踪运行状态、校验产物，并查询平台侧知识库确认入库结果。

该 NPC 默认使用 CNB AI 接入点，并启用知识库入库（嵌入模型 `bge-m3`）。
可配置参数与失败兜底方式见 [npc/codewiki](https://cnb.cool/npc/codewiki) 仓库说明。

NPC 的概念与召唤规则请参阅 [NPC](../build/npc.md)。

## 配置流水线生成

需要在每次打 Tag 等事件后自动生成时，改用流水线插件。

### 步骤 1：配置流水线

插件镜像：[cnbcool/codewiki](https://cnb.cool/cnb/plugins/cnbcool/codewiki)

在仓库的 `.cnb.yml` 中配置 codewiki 插件。建议使用 `tag_push` 事件触发，避免频繁生成 Wiki。
更多事件类型请参考 [构建触发规则](../build/trigger-rule.md)。

```yaml title=".cnb.yml"
$:
  tag_push:
    - docker:
        image: cnbcool/codewiki:latest
      stages:
        - name: generate codewiki
          timeout: 10h
          settings:
            git_doc_dir: /data/codewiki/${CNB_REPO_SLUG}
```

主要参数说明：

| 参数名 | 说明 | 默认值 | 是否必填 |
| --- | --- | --- | --- |
| `git_doc_dir` | Wiki 文档生成目录 | 无 | 是 |
| `use_codebuddy` | 是否使用 CodeBuddy 接入点；`1` 表示使用 CodeBuddy，`0` 表示使用 CNB AI | `1` | 否 |
| `llm_model_name` | 指定使用的 LLM 模型名称 | `deepseek-v3.1` | 否 |
| `knowledge_enabled` | 是否启用知识库入库 | `true` | 否 |
| `knowledge_embedding_model` | 知识库嵌入模型名称 | `hunyuan` | 否 |
| `knowledge_chunk_size` | 文本分块大小（token 数） | `1500` | 否 |
| `knowledge_chunk_overlap` | 相邻分块重叠 token 数量 | `0` | 否 |

> 开启后（默认已开启），生成的 Wiki 文档会自动入库到仓库知识库；无需入库时显式设为 `false`。

更多参数请参阅 [cnbcool/codewiki](https://cnb.cool/cnb/plugins/cnbcool/codewiki) 插件文档。

### 步骤 2：访问 CodeWiki

在仓库首页点击 Wiki 入口，进入 CodeWiki 页面。

## 自动进入知识库

CodeWiki 生成的内容会自动同步到仓库的知识库中。
同步完成后，仓库将被标记为知识库，可在 AI 对话中基于 CodeWiki 内容问答。

如需进一步了解知识库的配置与使用，请参阅 [知识库](./knowledge-base.md)。