kimi-code/docs/zh/configuration/config-files.md
Kaiyi 29cb33d862 fix(agent-core): close open tool calls in compacted prefixes and sync docs
Full compaction slices the raw history, which can exclude a delayed tool result and leave its tool_use open in the compacted prefix, triggering the same strict-provider 400 on the summary request. Synthesize a placeholder tool_result for such calls when projecting the compacted prefix.

Also sync the micro_compaction default to false in the en/zh configuration and env-var docs.
2026-06-30 13:55:20 +08:00

14 KiB
Raw Blame History

配置文件

Kimi Code CLI 把所有长期偏好写进 ~/.kimi-code/ 下的 TOML一种结构清晰的纯文本配置格式文件——比如使用哪个模型、填哪个 API 密钥、Agent 每轮最多跑几步。改一次每次启动都生效。Agent 与运行时设置放在 config.toml,终端界面与客户端偏好(主题、编辑器、通知、自动更新)放在配套的 tui.toml

默认位置:~/.kimi-code/config.toml,首次运行时自动创建。

配置文件位置

CLI 从 ~/.kimi-code/config.toml 读取配置。如需把数据目录迁移到别处,可用 KIMI_CODE_HOME 环境变量覆盖:

export KIMI_CODE_HOME=/path/to/kimi-home

此时配置文件路径变为 $KIMI_CODE_HOME/config.toml。无论目录在哪里,文件名固定是 config.toml

::: tip TOML 字段名一律用下划线snake_casedefault_modelmax_context_size。字段名里若含 .,需用引号包住,例如 [models."gpt-4.1"]——否则 TOML 会把 . 解释为嵌套表分隔符。 :::

完整示例

以下示例覆盖最常用的配置项,可直接复制后按需修改:

default_model = "kimi-code/kimi-for-coding"
default_thinking = true
default_permission_mode = "manual"
default_plan_mode = false
merge_all_available_skills = true
telemetry = true

[providers."managed:kimi-code"]
type = "kimi"
base_url = "https://api.kimi.com/coding/v1"
api_key = ""

[models."kimi-code/kimi-for-coding"]
provider = "managed:kimi-code"
model = "kimi-for-coding"
max_context_size = 262144

[thinking]
mode = "auto"

[loop_control]
max_retries_per_step = 3
reserved_context_size = 50000

[background]
max_running_tasks = 4
keep_alive_on_exit = false

[experimental]
micro_compaction = false

[[permission.rules]]
decision = "allow"
pattern = "Read"

[[permission.rules]]
decision = "deny"
pattern = "Bash(rm -rf*)"

[[hooks]]
event = "PreToolUse"
matcher = "Bash"
command = "node ~/.kimi-code/hooks/check-bash.mjs"
timeout = 5

顶层字段

配置文件里的字段分两类:顶层标量直接控制默认行为,嵌套表providersmodelsthinking 等)各有独立结构,在下文各节单独说明。

字段 类型 默认值 说明
default_model string 默认模型别名,必须在 models 中定义
default_thinking boolean false 新会话是否默认开启 Thinking深度推理模式可在会话内从模型菜单切换。即使设为 true[thinking].mode = "off" 也会强制关闭
default_permission_mode string manual 新会话的默认权限模式,可选 manual(逐次询问)、auto(自动批准读操作)、yolo(全部自动批准)
default_plan_mode boolean false 新会话是否默认以 Plan 模式(先出计划再执行)启动
merge_all_available_skills boolean true 是否合并所有目录中的 Agent Skills
extra_skill_dirs array<string> 额外 Skill 搜索目录,叠加到默认目录之上
telemetry boolean true 是否启用匿名遥测;显式设为 false 时关闭
providers table {} API 供应商表 → providers
models table 模型别名表 → models
thinking table Thinking 模式默认参数 → thinking
loop_control table Agent 循环控制参数 → loop_control
background table 后台任务运行参数 → background
experimental table 实验功能覆盖 → experimental
services table 内置外部服务配置 → services
permission table 初始权限规则 → permission
hooks array<table> 生命周期 hook详见 Hooks

以下各节对 providersmodelsthinkingloop_controlbackgroundexperimentalservicespermission 等嵌套表逐一展开。

providers

providers 表的每一项定义一个 API 供应商,以唯一名称为 key。CLI 只从这里读取凭证,不会从 shell 环境变量自动取后备值——在终端里 export KIMI_API_KEY 不会让供应商自动获得密钥,必须显式写在配置文件里(详见配置覆盖)。

字段 类型 必填 说明
type string 供应商类型:kimianthropicopenaiopenai_responsesgoogle-genaivertexai
api_key string API 密钥,明文写在配置文件里
base_url string API 基础 URL
oauth table OAuth 凭据引用(storagekey 两个字段),由登录流程自动注入,通常无需手写
env table<string, string> 供应商凭证的备用来源,详见下文
custom_headers table<string, string> 每次请求附加的自定义 HTTP 头

env 子表:可以把供应商惯用的键名(如 KIMI_API_KEY)写在 [providers.<name>.env] 里,作为 api_key / base_url 的备用来源。这个子表只在配置文件里读取,不会修改 shell 环境:

[providers.kimi.env]
KIMI_API_KEY = "sk-xxx"
KIMI_BASE_URL = "https://api.moonshot.ai/v1"

优先级:api_key 字段 > env 子表键 > 两者都缺时启动报错。

models

models 表的每一项定义一个模型别名(即 default_model-m 参数里使用的名称),以唯一名称为 key。

字段 类型 必填 说明
provider string 使用的供应商名称,必须在 providers 中定义
model string 调用 API 时实际传给服务端的模型 ID
max_context_size integer 最大上下文长度token 数),必须 ≥ 1
max_output_size integer 单次请求的输出 token 上限(对应 max_tokens)。目前仅 anthropic 供应商读取;已识别的 Claude 系列会自动限制在服务端允许的最大值内
capabilities array<string> 显式追加的能力标签:thinkingimage_invideo_inaudio_intool_use。与供应商自动识别的能力取并集,只能追加不能移除
display_name string UI 中显示的名称,未设时回退到 model
reasoning_key string openai 供应商。当网关用非标准字段名返回推理内容时才需要设置;默认自动识别 reasoning_content / reasoning_details / reasoning
adaptive_thinking boolean anthropic 供应商。强制开启或关闭 adaptive thinking覆盖按模型名推断的逻辑。省略时自动推断Claude ≥ 4.6 使用 adaptive

别名中含 . 时需要加引号:

[models."gpt-4.1"]
provider = "openai"
model = "gpt-4.1"
max_context_size = 1047576

无需修改配置文件也可以临时切换模型——通过 KIMI_MODEL_* 环境变量在内存里合成一个临时供应商,详见用环境变量定义模型

thinking

thinking 设置 Thinking 模式的全局默认行为。mode = "off" 会强制关闭 Thinking即使顶层 default_thinking = true 也不例外。

字段 类型 默认值 说明
mode string 触发策略:auto(由模型决定)、on(始终开启)、off(强制关闭)
effort string high Thinking 强度:lowmediumhighxhighmax,实际可用等级由供应商决定

loop_control

loop_control 控制 Agent 执行循环的步数上限、单步重试次数,以及触发上下文自动压缩的阈值。

字段 类型 默认值 说明
max_steps_per_turn integer 单轮最大步数;不设或设为 0 则无上限
max_retries_per_step integer 3 单步失败后的最大重试次数
reserved_context_size integer 预留给模型输出的 token 数;上下文窗口剩余量低于此值时触发自动压缩

background

background 控制后台任务(通过 Bash 工具或 Agent 工具的 run_in_background=true 参数启动)的并发数。

字段 类型 默认值 说明
max_running_tasks integer 同时运行的最大后台任务数
keep_alive_on_exit boolean false 会话关闭时是否保留仍在运行的后台任务。默认情况下Kimi Code 会在进程退出前请求停止所有后台任务;只有希望任务在会话结束后继续运行时才设为 true

keep_alive_on_exit 可被环境变量 KIMI_CODE_BACKGROUND_KEEP_ALIVE_ON_EXIT 覆盖,优先级高于配置文件。

experimental

experimental 存放实验功能 flag 的持久化覆盖。目前 micro_compaction 是唯一用户可见的字段,默认值为 false;如需自动清理较旧的大型工具结果,把它设为 true

字段 类型 默认值 说明
micro_compaction boolean false 清理较旧的大型工具结果内容,同时保留最近对话

services

services 配置网页搜索(moonshot_search)和网页抓取(moonshot_fetch)两项内置服务。只识别这两个固定 key其他 key 会被忽略。两项字段相同:

字段 类型 必填 说明
base_url string 服务 API URL
api_key string API 密钥
oauth table OAuth 凭据引用,结构同 providers.*.oauth
custom_headers table<string, string> 请求时附加的自定义 HTTP 头
[services.moonshot_search]
base_url = "https://api.moonshot.cn/v1/search"
api_key = "sk-xxx"

[services.moonshot_fetch]
base_url = "https://api.moonshot.cn/v1/fetch"
api_key = "sk-xxx"

permission

permission 设置会话启动时自动加载的权限规则,控制 Agent 调用工具时是否需要用户确认。规则用 [[permission.rules]] 数组表写出,按顺序匹配,第一条命中即生效。

字段 类型 必填 说明
decision string 匹配后的处置:allow(直接放行)、deny(直接拒绝)、ask(每次询问)
scope string 规则有效范围:turn-overridesession-runtimeprojectuser;默认 user
pattern string 匹配模式,格式为 工具名工具名(参数模式),如 ReadBash(rm -rf*)
reason string 规则说明,仅用于调试和审计

内置工具名见内置工具。大多数支持规则参数的内置工具会定义自己的匹配对象,例如 Bash(command-pattern)Read(path-pattern)AgentSwarm、MCP 工具和自定义工具只能按工具名匹配,不支持参数模式。

[[permission.rules]]
decision = "allow"
pattern = "Read"

[[permission.rules]]
decision = "allow"
pattern = "Grep"

[[permission.rules]]
decision = "deny"
pattern = "Bash(rm -rf*)"

[[permission.rules]]
decision = "ask"
pattern = "Bash"

::: tip MCP server 的声明配置写在 ~/.kimi-code/mcp.json 或项目内 .kimi-code/mcp.json 中,不在 config.toml 里。交互式配置入口是 /mcp-config,详见 Model Context Protocol。 :::

tui.toml

除了 config.tomlCLI 还在同一目录下用一份配套的 tui.toml 保存终端界面与客户端偏好(~/.kimi-code/tui.toml,或覆盖后的 $KIMI_CODE_HOME/tui.toml)。它在首次运行时以默认值创建,交互式命令 /config/theme/editor 会自动写入通常无需手动编辑。文件格式有误时CLI 会回退到默认值并给出提示,而不是启动失败。

字段 类型 默认值 说明
theme string auto 配色主题:auto(跟随终端)、darklight,或自定义主题的名字
[editor].command string "" 编写长输入用的外部编辑器命令;留空则回退到 $VISUAL / $EDITOR
[notifications].enabled boolean true 是否发送桌面通知
[notifications].notification_condition string unfocused 何时通知:unfocused(仅终端失去焦点时)或 always(总是)
[upgrade].auto_install boolean true 是否自动安装新版本
# ~/.kimi-code/tui.toml
theme = "auto" # "auto" | "dark" | "light" | 自定义主题名

[editor]
command = "" # 留空则使用 $VISUAL / $EDITOR

[notifications]
enabled = true
notification_condition = "unfocused" # "unfocused" | "always"

[upgrade]
auto_install = true

修改在下次启动时生效,或用 /reload-tui 立即生效(只重载 tui.toml/reload 会同时重载 config.tomltui.toml

项目级本地配置

除了 ~/.kimi-code 下的用户级文件Kimi Code 还会读取位于 <项目根目录>/.kimi-code/local.toml 的项目级本地配置文件。它保存的是与某一个项目检出相关、通常不应与队友共享的设置。

该文件会在你通过 /add-dir 添加额外工作目录并选择记入项目时自动创建,通常无需手动编辑。

[workspace]

[workspace] 表用于存放项目级的工作区设置:

字段 类型 必填 说明
additional_dir array<string> 额外工作目录列表,以绝对路径存储。在 /add-dir 中确认"记住此目录"时自动写入;启动时读回,使这些目录在该项目的每个会话中都可用
[workspace]
additional_dir = ["/absolute/path/to/shared"]

目录以绝对路径存储,与具体机器相关。因此建议把 .kimi-code/local.toml 加入项目的 .gitignore,避免被提交。

下一步

  • 平台与模型 — 各供应商类型Kimi、Claude、OpenAI、Gemini的接入示例
  • 配置覆盖 — CLI 选项、配置文件、环境变量的优先级规则
  • 环境变量KIMI_CODE_HOME 等运行时变量的完整列表