---
url: /zh/repo/settings.md
---
可通过在仓库根目录新增 `.cnb/settings.yml` 配置文件对页面部分 UI 进行定制，解锁更多玩法

## 配置文件说明

需在仓库根目录新增并提交 `.cnb/settings.yml` 配置文件，如下为配置文件示例：

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

# 云原生开发配置，读取云原生启动按钮所在页面当前分支的 .cnb/settings.yml 配置
workspace:
  launch:
    # 定制云原生开发启动按钮
    button:
      # 按钮名称
      name: 启动云原生开发
      # 按钮描述
      # 如果值为 null，则不显示默认描述
      description: 点击此按钮启动云原生开发环境
      # 鼠标悬浮在按钮上显示的图片
      # 1.用仓库中当前分支的图片，填写相对仓库根目录的路径，如 .cnb/launch-hover.gif;
      # 2.使用当前域名下的文件 raw 地址，比如：https://cnb.cool/my/test/-/git/raw/main/launch-hover.gif
      # 图片最大 10MB
      hoverImage: .cnb/launch-hover.gif
    # CPU 核心数，默认为：8。仅对默认模版有效，如果有自定义云原生开发启动流水线，则此配置无效
    cpus: 4
    # 是否禁用默认按钮。默认为：false 表示不禁用。true 表示禁用
    disabled: false
    # 环境创建完是否自动打开 WebIDE，默认为 false
    # 当开发环境中未安装 openssh(仅支持 WebIDE)：无论此参数配置为 true 还是 false，环境创建完都将自动打开 WebIDE
    autoOpenWebIDE: false

# issue 配置，读取仓库默认分支 .cnb/settings.yml 配置
issue:
  # 定制创建 issue 按钮
  button:
    # 按钮描述
    description: ~bug~ 给你!
    # 鼠标悬浮在按钮上显示的图片
    # 1.用仓库中当前分支的图片，填写相对仓库根目录的路径，如 .cnb/issue-hover.png;
    # 2.使用当前域名下的文件 raw 地址，比如：https://cnb.cool/my/test/-/git/raw/main/issue-hover.png
    # 图片最大 10MB
    hoverImage: https://cnb.cool/my/test/-/git/raw/main/issue-hover.png

# fork 配置，读取仓库默认分支 .cnb/settings.yml 配置
fork:
  # 定制 fork 按钮
  button:
    # 按钮描述
    description: 你的仓库不错，现在是我的了
    # 鼠标悬浮在按钮上显示的图片
    # 1.用仓库中当前分支的图片，填写相对仓库根目录的路径，如 .cnb/fork-hover.png;
    # 2.使用当前域名下的文件 raw 地址，比如：https://cnb.cool/my/test/-/git/raw/main/.cnb/fork-hover.png
    # 图片最大 10MB
    hoverImage: .cnb/fork-hover.png

# 抄作业 按钮配置，读取仓库默认分支 .cnb/settings.yml 配置
# 仓库首页默认没有此按钮
# 抄作业按钮出现条件：仓库首页右方简介增加 example 标签（推荐可作为模板或例子的仓库增加此按钮）
copyRepo:
  # 定制 抄作业 按钮
  button:
    # 按钮描述
    description: 你的仓库不错，现在是我的了
    # 鼠标悬浮在按钮上显示的图片
    # 1.用仓库中当前分支的图片，填写相对仓库根目录的路径，如 .cnb/copy-hover.png;
    # 2.使用当前域名下的文件 raw 地址，比如：https://cnb.cool/my/test/-/git/raw/main/.cnb/copy-hover.png
    # 图片最大 10MB
    hoverImage: .cnb/copy-hover.png

# 点赞功能自定义图片
reaction:
  # 定义点赞功能 "bug 拿着" 位置的替换图片
  # 只能用仓库中默认分支的图片，填写相对仓库根目录的路径，如 .cnb/bug.gif
  bug:
    image: .cnb/bug.gif

# tag 配置，读取仓库默认分支 .cnb/settings.yml 配置
tag:
  # 自动生成 Tag 配置
  auto_tag:
    # 指定触发自动打 Tag 的分支名，如不配置则默认使用仓库默认分支来创建 Tag
    branch: hotfix

# NPC 配置
npc:
  # 引入其他仓库 AI 配置
  imports:
    # 引用的仓库列表
    list:
      - cnb/docs
  # 当前仓库的角色列表
  roles:
    - name: 小李
      # slogan
      slogan: code is cheap, show me your prompt
      # 角色描述提示词
      prompt: 你现在是小李，一名前端开发工程师
      # 是否开启思考模式，boolean类型，默认为 true
      enableThinking: false
      # 角色头像信息
      avatar:
        # 头像图片地址
        # 只能用仓库中默认分支的图片，填写相对仓库根目录的路径，如 .cnb/knowledge-base-hover.png
        src: ".cnb/knowledge-base-hover.png"
    - name: 小王
      prompt: |
        你是一名资浅工程师，
        卖萌是你的主营业务，
  # 知识库文档弹窗的默认选中仓库
  defaultRepo: "cnb/docs"
  # 默认角色
  defaultRole: "资浅工程师"
  # 知识库按钮的web界面样式
  button:
    # 按钮名称
    name: "快速问AI"
    # 按钮描述
    description: “点火, 启动 AI!”
    # 只能用仓库中默认分支的图片，填写相对仓库根目录的路径，如 .cnb/knowledge-base-hover.png
    hoverImage: ".cnb/knowledge-base-hover.png"
```

:::tip
注意：当文件解析失败或大小超过限制，将不会使用该配置
:::

## 抄作业按钮

仓库首页默认不会出现 `抄作业` 按钮，推荐可作为模板或例子的仓库增加此按钮。

如何增加此按钮：在仓库首页右侧简介编辑按钮，增加 `example` 标签，即可出现此按钮

点击该按钮，获取快速复制该仓库的具体方法