---
url: /zh/repo/settings.md
description: >
  通过 .cnb/settings.yml 配置文件定制仓库页面 UI，包括云原生开发、Issue、Fork、抄作业按钮， 以及 NPC、点赞图片、Tag
  自动生成等配置。
---
在仓库根目录添加 `.cnb/settings.yml` 即可定制页面 UI。所有参数均为可选。

以下完整配置文件示例涵盖全部定制分类，各分类均可按需配置，未配置项使用默认值。

**云原生开发、Issue、Fork、抄作业按钮**：

```yaml title=".cnb/settings.yml"
# 云原生开发配置（读取启动按钮所在分支的配置）
workspace:
  launch:
    button:
      name: 启动云原生开发
      description: 点击此按钮启动云原生开发环境
      hoverImage: .cnb/launch-hover.gif
    cpus: 4
    disabled: false
    autoOpenWebIDE: false

# Issue 配置（读取默认分支的配置）
issue:
  button:
    description: ~bug~ 给你!
    hoverImage: https://cnb.cool/my/test/-/git/raw/main/issue-hover.png

# Fork 配置（读取默认分支的配置）
fork:
  button:
    description: 你的仓库不错，现在是我的了
    hoverImage: .cnb/fork-hover.png

# 抄作业按钮配置（读取默认分支的配置）
copyRepo:
  button:
    description: 你的仓库不错，现在是我的了
    hoverImage: .cnb/copy-hover.png
```

**点赞图片、Tag 自动生成**：

```yaml title=".cnb/settings.yml"
# 点赞功能自定义图片
reaction:
  bug:
    image: .cnb/bug.gif

# Tag 配置（读取默认分支的配置）
tag:
  auto_tag:
    branch: hotfix
```

**NPC 配置**：

```yaml title=".cnb/settings.yml"
npc:
  imports:
    list:
      - cnb/docs
  roles:
    - name: 代码助手
      slogan: code is cheap, show me your prompt
      prompt: 你现在是代码助手，专注于协助编写和优化代码
      enableThinking: false
      avatar:
        src: ".cnb/knowledge-base-hover.png"
    - name: 审查员
      prompt: |
        你是一名代码审查员，专注于代码质量把控和改进建议。
  defaultRepo: "cnb/docs"
  defaultRole: "审查员"
  button:
    name: "快速问AI"
    description: "点火，启动 AI!"
    hoverImage: ".cnb/knowledge-base-hover.png"
```

:::tip
文件解析失败或超过大小限制时，配置将不会生效。
:::

## 定制分类

UI 定制支持以下类别，点击查看各分类的详细配置说明：

| 分类                                         | 说明                                               | 配置读取分支 |
|----------------------------------------------|----------------------------------------------------|-------------|
| [云原生开发按钮定制](./settings-workspace.md) | 启动按钮的名称、描述、悬浮图片、CPU 核心数等       | 当前分支    |
| [Issue 按钮定制](./settings-issue.md)         | 创建 Issue 按钮的描述和悬浮图片                    | 默认分支    |
| [Fork 按钮定制](./settings-fork.md)           | Fork 按钮的描述和悬浮图片                          | 默认分支    |
| [抄作业按钮定制](./settings-copy-repo.md)     | 抄作业按钮的描述和悬浮图片                         | 默认分支    |
| [点赞功能自定义图片](./settings-reaction.md)  | 替换点赞功能中的默认图片                           | 默认分支    |
| [Tag 自动生成配置](./settings-tag.md)         | 配置自动打 Tag 的触发分支                          | 默认分支    |
| [NPC 配置](./settings-npc.md)                 | AI 角色列表、知识库、提示词等                      | 默认分支    |