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

## 配置文件说明

在仓库根目录创建并提交 `.cnb/settings.yml` 文件，示例如下：

```yaml title=".cnb/settings.yml"
# 如下参数均为可选参数

# 云原生开发配置，读取云原生启动按钮所在页面当前分支的 .cnb/settings.yml 配置
workspace:
  launch:
    button:
      name: 启动云原生开发
      description: 点击此按钮启动云原生开发环境
      hoverImage: .cnb/launch-hover.gif
    cpus: 4
    disabled: false
    autoOpenWebIDE: false

# issue 配置，读取仓库默认分支 .cnb/settings.yml 配置
issue:
  button:
    description: ~bug~ 给你!
    hoverImage: https://cnb.cool/my/test/-/git/raw/main/issue-hover.png

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

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

# 点赞功能自定义图片
reaction:
  bug:
    image: .cnb/bug.gif

# tag 配置，读取仓库默认分支 .cnb/settings.yml 配置
tag:
  auto_tag:
    branch: hotfix

# NPC 配置
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 核心数、自动打开 WebIDE 等 | 当前分支 |
| [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 角色列表、知识库、提示词等 | 默认分支 |