配置 - Docs by LangChain

CLI 将配置存储在 ~/.deepagents/ 目录中。主要配置文件包括：

文件	格式	用途
`config.toml`	TOML	模型默认值、提供商设置、构造参数、配置覆盖、主题、更新设置、MCP 信任存储
`.env`	Dotenv	全局 API 密钥和密钥
`hooks.json`	JSON	外部工具订阅 CLI 生命周期事件
`.mcp.json`	JSON	全局 MCP 服务器定义

~/.deepagents/.state/ 下的文件保存每台机器的 CLI 状态，由 CLI 自动管理。.state/ 目录在 deepagents-cli>=0.0.49 中引入。

提供商凭证

对于每个提供商，CLI 按以下顺序检查两个凭证来源：

已存储的密钥 — 通过 /auth 输入并本地持久化。
环境变量 — OPENAI_API_KEY、ANTHROPIC_API_KEY、GOOGLE_API_KEY 等，以及带有 DEEPAGENTS_CLI_ 前缀的同名变量和从 .env 文件加载的密钥。

已存储的密钥始终优先于同一提供商的环境变量密钥。

使用 `/auth`（推荐）

在任何会话中打开凭证管理器：

/auth

管理器会列出 CLI 已知的每个大语言模型(LLM)提供商，标记已有密钥的提供商，并允许你内联粘贴、轮换或清除凭证。每个提供商显示为以下之一：

标签	含义
`✓ credentials set`	已有存储的或环境变量密钥可用
`! missing OPENAI_API_KEY`	指定的环境变量未设置且无存储密钥 — 选择该行粘贴一个
`local provider`	无需凭证（例如本地 Ollama）
`implicit auth`	凭证是隐式的（例如 Vertex AI 应用默认凭证）
`custom auth`	`class_path` 提供商管理自己的认证（mTLS、JWT、自定义头）

按 Enter 选择一行粘贴密钥，或使用该行的删除功能清除现有密钥。保存的密钥以原子方式写入，在会话和 /reload 之间持久存在。

密钥的作用域限定在此机器上的你的用户账户 — CLI 除了发送到已配置提供商的 API 外，不会将密钥传输到任何其他地方。

/auth 仅管理 LLM 提供商凭证。工具凭证如 TAVILY_API_KEY（网页搜索）和 LANGSMITH_API_KEY（追踪）从环境中读取 — 在 ~/.deepagents/.env 或你的 shell 中设置。

环境变量（CI 和无头环境）

对于非交互式运行、CI/CD 管道或任何没有 TUI 可用的场景，导出提供商的环境变量或将其写入 ~/.deepagents/.env：

export ANTHROPIC_API_KEY="sk-ant-..."
export OPENAI_API_KEY="sk-..."

参见下方环境变量了解加载顺序、DEEPAGENTS_CLI_ 前缀和按项目覆盖。

环境变量

CLI 从 dotenv 文件加载环境变量，因此你不需要在 shell 配置文件中 export API 密钥，也不需要在项目之间复制 .env 文件。

加载顺序和优先级

启动时加载两个 .env 文件：

项目 .env — 当前工作目录中的 .env 文件（如果存在）
全局 ~/.deepagents/.env — 作为所有项目后备的单一共享文件

有效优先级为：shell 环境 > 项目 .env > 全局 .env。已在 shell 中设置的值永远不会被覆盖 — 包括 /reload 时。

`DEEPAGENTS_CLI_` 前缀

所有 CLI 特定的环境变量使用 DEEPAGENTS_CLI_ 前缀（例如 DEEPAGENTS_CLI_AUTO_UPDATE、DEEPAGENTS_CLI_DEBUG）。参见 CLI 环境变量参考获取完整列表。该前缀也可作为 CLI 读取的任何环境变量（包括第三方凭证）的覆盖机制。CLI 先检查 DEEPAGENTS_CLI_{NAME}，然后回退到 {NAME}：

~/.deepagents/.env

# 仅为 CLI 覆盖 OPENAI_API_KEY，不影响其他工具
DEEPAGENTS_CLI_OPENAI_API_KEY=sk-cli-only

# 通过将带前缀的变量设为空来在 CLI 中阻止 shell 导出的密钥
DEEPAGENTS_CLI_ANTHROPIC_API_KEY=

执行 /reload 时，CLI 会重新读取 .env 文件并获取带前缀的值，因此你可以在不重启的情况下轮换密钥。

示例

将 API 密钥存储在 ~/.deepagents/.env 中一次：

ANTHROPIC_API_KEY=sk-ant-...
OPENAI_API_KEY=sk-...
LANGSMITH_API_KEY=lsv2_...
TAVILY_API_KEY=tvly-...

# 如果 OPENAI_API_KEY 已在你的 shell 中为其他工具导出，
# 使用前缀为 CLI 提供自己的密钥而不产生冲突
DEEPAGENTS_CLI_OPENAI_API_KEY=sk-cli-only-...

然后在需要时，通过在项目目录中放置 .env 来按项目覆盖。

使用 Tavily 启用网页搜索

内置的 web_search 工具使用 Tavily。在你提供密钥之前，CLI 会在启动时显示”Web search disabled — TAVILY_API_KEY is not set”通知。与模型提供商密钥不同，Tavily 不由 /auth 管理；它直接从环境中读取。

获取密钥

在 tavily.com 注册并复制密钥（以 tvly- 开头）。免费层对大多数 CLI 使用已经足够。

添加到你的环境

将密钥添加到 ~/.deepagents/.env，使每个会话都能获取它：

~/.deepagents/.env

TAVILY_API_KEY=tvly-...

或者在你的 shell 中为一次性会话导出：

export TAVILY_API_KEY=tvly-...

Shell 导出优先于 .env 值（参见加载顺序和优先级）。要将密钥仅限于 CLI 而不影响读取 TAVILY_API_KEY 的其他工具，使用 DEEPAGENTS_CLI_ 前缀：DEEPAGENTS_CLI_TAVILY_API_KEY=tvly-...。

重新加载或重启

在现有会话中，运行 /reload 重新读取 .env 文件。下次启动时，“Web search disabled”通知消失，智能体可以调用 web_search。

配置文件

~/.deepagents/config.toml 允许你自定义模型提供商、设置默认值并向模型构造函数传递额外参数。

默认和最近使用的模型

[models]
default = "ollama:qwen3:4b"             # 你有意设置的长期偏好
recent = "google_genai:gemini-3.1-pro-preview"   # 上次 /model 切换（自动写入）

[models].default 始终优先于 [models].recent。/model 命令仅写入 [models].recent，因此你配置的默认值永远不会被会话中途切换覆盖。要移除默认值，使用 /model --default --clear 或从配置文件中删除 default 键。

默认和最近使用的智能体

[agents]
default = "backend-dev"  # 你有意设置的长期偏好（在 /agents 选择器中 Ctrl+S）
recent = "frontend-dev"  # 上次 /agents 切换（自动写入）

[agents].default 始终优先于 [agents].recent。在 /agents 选择器中用 Enter 选择智能体会写入 recent；在高亮行上按 Ctrl+S 将其固定为 default。再次在同一行上按 Ctrl+S 清除默认值。显式的 -a/--agent 始终覆盖两者，-r/--resume 绕过两者以恢复线程的原始智能体。参见命令参考了解相关标志。

提供商配置

每个提供商是 [models.providers] 下的一个 TOML 表：

[models.providers.<name>]
models = ["gpt-4o"]
api_key_env = "OPENAI_API_KEY"
base_url = "https://api.openai.com/v1"
class_path = "my_package.models:MyChatModel"
enabled = true

[models.providers.<name>.params]
temperature = 0
max_tokens = 4096

[models.providers.<name>.params."gpt-4o"]
temperature = 0.7

提供商有以下配置选项：

models

string[]

optional

在交互式 /model 切换器中为此提供商显示的模型名称列表。对于已附带模型配置文件的提供商，你在此添加的名称会与捆绑的名称一起显示，适用于尚未添加到包中的新发布模型。对于任意提供商，此列表是切换器中模型的唯一来源。此处列出的模型绕过基于配置文件的过滤条件，始终出现在切换器中。这使其成为显示因配置文件缺少 tool_calling 支持或尚不存在而被排除的模型的推荐方式。此键是可选的。无论模型是否出现在切换器中，你始终可以直接通过 /model 或 --model 传递任何模型名称；提供商会在请求时验证该名称。

api_key_env

string

optional

保存 API 密钥的环境变量的名称（例如 "OPENAI_API_KEY"），而非密钥本身。CLI 在启动时从此环境变量读取凭证以在创建模型之前验证访问权限。大多数聊天模型包会自动从默认环境变量读取。参见提供商参考表了解每个提供商检查哪个变量。

base_url

string

optional

覆盖提供商使用的基础 URL（如果支持）。请参阅你的提供商包的参考文档获取更多信息。

params

object

optional

转发给模型构造函数的额外关键字参数。平面键（例如 temperature = 0）适用于此提供商的每个模型。模型键子表（例如 [params."gpt-4o"]）仅为该模型覆盖单个值；合并是浅层的（模型在冲突时优先）。不要在 params 中放置凭证（例如 api_key）。使用 api_key_env 指向环境变量。

profile

object

optional

（高级）覆盖模型运行时配置文件中的字段（例如 max_input_tokens）。平面键适用于此提供商的每个模型。模型键子表（例如 [profile."claude-sonnet-4-5"]）仅为该模型覆盖单个值；合并是浅层的（模型在冲突时优先）。这些覆盖在模型创建后应用，因此它们对上下文限制显示、自动摘要以及任何其他读取配置文件的功能生效。

class_path

string

optional

用于任意模型提供商。module.path:ClassName 格式的完全限定 Python 类。设置后，CLI 直接为提供商 <name> 导入并实例化此类。该类必须是 BaseChatModel 子类。

enabled

boolean

default:"true"

optional

此提供商是否出现在 /model 选择器中。设为 false 可隐藏从已安装包自动发现的提供商（例如你不想在切换器中出现的传递依赖）。你仍然可以通过 /model provider:model 或 --model 直接使用已禁用的提供商。

模型构造参数

任何提供商都可以使用 params 表向模型构造函数传递额外参数：

[models.providers.ollama.params]
temperature = 0
num_ctx = 8192

按模型覆盖

如果特定模型需要不同的参数，在 params 下添加模型键子表来覆盖单个值，而无需复制整个提供商配置：

[models.providers.ollama]
models = ["qwen3:4b", "llama3"]

[models.providers.ollama.params]
temperature = 0
num_ctx = 8192

[models.providers.ollama.params."qwen3:4b"]
temperature = 0.5
num_ctx = 4000

使用此配置：

ollama:qwen3:4b 获取 {temperature: 0.5, num_ctx: 4000} — 模型覆盖优先。
ollama:llama3 获取 {temperature: 0, num_ctx: 8192} — 无覆盖，仅提供商级参数。

合并是浅层的：模型子表中存在的任何键替换提供商级参数中的同名键，而仅在提供商级别的键保留。

对于不编辑 config.toml 的一次性调整，在启动时通过 --model-params 传递 JSON 对象或在会话中使用 /model。CLI 标志的优先级高于配置文件。参见提供商页面的模型参数了解语法和特定提供商的示例。

配置文件覆盖（高级）

覆盖模型运行时配置文件中的字段以更改 CLI 解释模型能力的方式。最常见的用例是降低 max_input_tokens 以更早触发自动摘要 — 适用于测试或限制上下文使用：

# 应用于此提供商的所有模型
[models.providers.anthropic.profile]
max_input_tokens = 4096

按模型子表的工作方式与 params 相同 — 模型级值在冲突时优先：

[models.providers.anthropic.profile]
max_input_tokens = 4096

# 此模型获取更高的限制
[models.providers.anthropic.profile."claude-sonnet-4-5"]
max_input_tokens = 8192

配置文件覆盖在创建后合并到模型的配置文件中。任何读取配置文件的功能 — 状态栏中的上下文限制显示、自动摘要阈值、能力检查 — 都会看到覆盖后的值。

使用 `--profile-override` 的 CLI 配置文件覆盖（高级）

要在运行时覆盖模型配置文件字段而不编辑配置文件，通过 --profile-override 传递 JSON 对象：

deepagents --profile-override '{"max_input_tokens": 4096}'

# 与 --model 组合
deepagents --model google_genai:gemini-3.1-pro-preview --profile-override '{"max_input_tokens": 4096}'

# 在非交互模式中
deepagents -n "Summarize this repo" --profile-override '{"max_input_tokens": 4096}'

这些覆盖在配置文件覆盖之上合并（CLI 优先）。优先级链为：模型默认值 < config.toml profile < CLI --profile-override。 --profile-override 值在会话中途 /model 热切换时保持 — 切换模型会将覆盖重新应用到新模型。

自定义基础 URL

一些提供商包接受 base_url 来覆盖默认端点。例如，langchain-ollama 通过底层 ollama 客户端默认使用 http://localhost:11434。要将其指向其他地方，在配置中设置 base_url：

[models.providers.ollama]
base_url = "http://your-host-here:port"

请参阅你的提供商的参考文档了解兼容性信息和其他注意事项。

兼容 API

对于暴露与 OpenAI 或 Anthropic 线路兼容 API 的提供商，你可以通过将 base_url 指向提供商的端点来使用现有的 langchain-openai 或 langchain-anthropic 包：

[models.providers.openai]
base_url = "https://api.example.com/v1"
api_key_env = "EXAMPLE_API_KEY"
models = ["my-model"]

[models.providers.anthropic]
base_url = "https://api.example.com"
api_key_env = "EXAMPLE_API_KEY"
models = ["my-model"]

提供商在官方规范之上添加的任何功能都不会被捕获。如果提供商提供专用的 LangChain 集成包，请优先使用。

OpenAI 提供商默认使用 Responses API，大多数 OpenAI 兼容网关不实现该 API。如果你的提供商仅支持 Chat Completions API，调用可能会失败。请显式禁用 Responses API：

[models.providers.openai.params]
use_responses_api = false

将模型添加到交互式切换器

一些提供商（例如 langchain-ollama）不捆绑模型配置文件数据（参见提供商参考获取完整列表）。在这种情况下，交互式 /model 切换器不会列出该提供商的模型。你可以通过在配置文件中为提供商定义 models 列表来填补空白：

[models.providers.ollama]
models = ["llama3", "mistral", "codellama"]

/model 切换器现在将包含一个列出这些模型的 Ollama 部分。这完全是可选的。你始终可以通过直接指定完整名称来切换到任何模型：

/model ollama:llama3

当 langchain-ollama 已安装且守护进程可达时，CLI 会自动发现本地已拉取的模型并将它们合并到切换器中 — 无需 models 列表。在拉取新模型后运行 /reload 刷新，或设置 DEEPAGENTS_CLI_OLLAMA_DISCOVERY=0 退出自动发现。

任意提供商

你可以使用 class_path 来使用任何 LangChain BaseChatModel 子类。CLI 直接导入并实例化该类 — 不需要内置提供商包。

[models.providers.my_custom]
class_path = "my_package.models:MyChatModel"
api_key_env = "MY_API_KEY"
base_url = "https://my-endpoint.example.com"

[models.providers.my_custom.params]
temperature = 0
max_tokens = 4096

api_key_env 和 base_url 是可选的。class_path 提供商应在内部处理自己的认证 — 当你的模型使用自定义认证（JWT 令牌、专有头、mTLS 等）而非标准 API 密钥时很有用：

[models.providers.xyz]
class_path = "abc.integrations.deepagents:DeepAgentsXYZChat"
models = ["abc-xyz-1"]

[models.providers.xyz.params]
bypass_auth = true
temperature = 0

使用此配置，通过 /model xyz:abc-xyz-1 或 --model xyz:abc-xyz-1 切换到该模型。

深度智能体 CLI 需要工具调用支持。如果你的自定义模型支持工具调用但 CLI 不知道，请在提供商配置文件中声明：

[models.providers.xyz.profile]
tool_calling = true
max_input_tokens = 128000

将 max_input_tokens 设置为你的模型支持的值，以启用准确的上下文长度跟踪和自动摘要。

提供商包必须安装在与 deepagents-cli 相同的 Python 环境中：

# 如果 deepagents-cli 是通过 uv tool 安装的：
uv tool install deepagents-cli --with my_package

当你切换到 my_custom:my-model-v1（通过 /model 或 --model）时，模型名称（my-model-v1）作为 model 关键字参数传递：

MyChatModel(model="my-model-v1", base_url="...", api_key="...", temperature=0, max_tokens=4096)

class_path 从你的配置文件执行任意 Python 代码。这与 pyproject.toml 构建脚本具有相同的信任模型 — 你控制自己的机器。

你的提供商包可以选择在 <package>.data._profiles 的 _PROFILES 字典中提供模型配置文件，以代替在 models 键下定义它们。参见 LangChain 模型配置文件获取更多信息。

技能额外允许的目录

默认情况下，当 CLI 加载技能时，它会验证解析的技能文件路径是否位于标准技能目录之一内。这可以防止技能目录内的符号链接读取这些根目录之外的任意文件。如果你将共享技能资产存储在非标准位置，并使用从标准技能目录到它们的符号链接引用，你可以将该位置添加到容器允许列表中。这不会添加新的技能发现位置：技能仍然只从标准目录发现。

extra_allowed_dirs

string[]

optional

添加到技能容器允许列表的路径。支持 ~ 展开。

[skills]
extra_allowed_dirs = [
    "~/shared-skills",
    "/opt/team-skills",
]

或者，将 DEEPAGENTS_CLI_EXTRA_SKILLS_DIRS 环境变量设置为冒号分隔的列表：

export DEEPAGENTS_CLI_EXTRA_SKILLS_DIRS="~/shared-skills:/opt/team-skills"

设置环境变量时，它优先于配置文件值。更改在 /reload 时生效。

主题

使用 /theme 打开交互式主题选择器。浏览列表实时预览主题，按 Enter 将选择持久化到 config.toml。 CLI 附带许多内置主题。默认主题是 langchain，一个带有 LangChain 品牌颜色的深色主题。选中的主题保存在 [ui] 下：

[ui]
theme = "langchain-dark"

用户自定义主题

在 config.toml 中的 [themes.<name>] 部分定义自定义主题。每个部分需要 label（字符串）。dark（布尔值）如果省略默认为 false — 对于深色主题设置为 true。所有颜色字段都是可选的 — 省略的字段根据 dark 标志回退到内置的深色或浅色调色板。

[themes.my-solarized]
label = "My Solarized"
dark = true
primary = "#268BD2"
warning = "#B58900"

# 带空格的主题名称需要 TOML 引号
[themes."ocean breeze"]
label = "Ocean Breeze"
primary = "#0077B6"
background = "#CAF0F8"

用户自定义主题与内置主题一起出现在 /theme 选择器中。

覆盖内置主题颜色

要调整内置主题的颜色而不创建新主题，使用 [themes.<builtin-name>] 部分。只读取颜色字段 — label 和 dark 从内置继承：

[themes.langchain]
primary = "#FF5500"

省略的颜色字段保留现有的内置值。对 [themes.*] 部分的更改在 /reload 时生效。

将主题映射到终端

如果你在具有不同配色方案的终端之间切换（例如深色 iTerm 和浅色 Apple Terminal），在 [ui.terminal_themes] 下将每个终端映射到一个主题。CLI 匹配 shell 的 TERM_PROGRAM 并自动应用映射的主题：

[ui.terminal_themes]
"Apple_Terminal" = "langchain-light"
"iTerm.app" = "langchain"

在 /theme 选择器中按 T 将高亮的主题保存给当前终端，或运行 echo $TERM_PROGRAM 找到你终端的标识符并手动添加。

高级：选择器快捷键、解析顺序、终端标识符

选择器快捷键

在 /theme 选择器中：

N 在显示标签和规范注册键之间切换 — 键是 [ui] theme 和 [ui.terminal_themes] 接受的值。
T 将高亮的主题保存到 [ui.terminal_themes] 中给当前 TERM_PROGRAM。映射的主题在选择器中标记为 (default)。

常见 `TERM_PROGRAM` 值

键与环境变量逐字匹配 — 当包含点或特殊字符时在 TOML 中引用它们。

终端	`TERM_PROGRAM`
Apple Terminal	`Apple_Terminal`
iTerm2	`iTerm.app`
WezTerm	`WezTerm`
VS Code 集成终端	`vscode`
Ghostty	`ghostty`

解析顺序

CLI 在每次启动时使用以下优先级解析主题：

DEEPAGENTS_CLI_THEME 环境变量（显式覆盖）。
当前 TERM_PROGRAM 的 [ui.terminal_themes] 映射。
[ui] theme 保存的偏好（由 /theme 设置）。
内置默认值（langchain）。

自动更新

CLI 可以自动检查并安装更新。

配置文件
环境变量

[update]
auto_update = true

export DEEPAGENTS_CLI_AUTO_UPDATE=1

环境变量优先于配置文件。启用后，CLI 在会话开始时检查 PyPI 是否有更新版本，并使用检测到的安装方法（uv、Homebrew 或 pip）自动升级。禁用时（默认），CLI 会显示带有适当安装命令的更新提示。你也可以随时使用 /update 斜杠命令手动检查和安装更新，该命令绕过缓存并在行内报告成功或失败。升级后，CLI 在下次启动时显示”更新内容”横幅，并附带变更日志链接。在会话退出时，如果在会话期间检测到较新版本，将显示更新横幅作为提醒。

托管部署

安装脚本支持以 root 身份运行，针对 macOS MDM 工具（Kandji、Jamf 等）在最小化 root 环境中执行脚本。当 id -u 为 0 时，脚本：

解析真实控制台用户的 HOME（通过 /dev/console 或 /Users 目录扫描）
在每个安装步骤后将所有创建的文件 chown 回目标用户

非 root 安装不受影响：所有 root 特定的代码路径在非 root 运行时短路。要为托管安装预配置自动更新，在用户的 shell 配置文件中设置 DEEPAGENTS_CLI_AUTO_UPDATE=1，或将带有 [update] auto_update = true 的 config.toml 部署到 ~/.deepagents/config.toml。要完全抑制自动更新和更新检查，设置 DEEPAGENTS_CLI_NO_UPDATE_CHECK=1。

CLI 环境变量参考

所有 CLI 特定的环境变量使用 DEEPAGENTS_CLI_ 前缀。参见 DEEPAGENTS_CLI_ 前缀了解该前缀如何作为第三方凭证的覆盖。

DEEPAGENTS_CLI_AUTO_UPDATE

string

optional

启用自动 CLI 更新（1、true 或 yes）。

DEEPAGENTS_CLI_DEBUG

string

optional

启用详细调试日志记录到文件。接受 1、true、yes、on（不区分大小写）作为启用；0、false、no、off、空字符串或未设置则禁用。启用后，每个会话的服务器日志文件在关闭时保留，其路径打印到 stderr 用于排查。

DEEPAGENTS_CLI_DEBUG_FILE

string

default:"/tmp/deepagents_debug.log"

optional

调试日志文件的路径。

DEEPAGENTS_CLI_EXTRA_SKILLS_DIRS

string

optional

冒号分隔的路径，添加到技能容器允许列表。

DEEPAGENTS_CLI_LANGSMITH_PROJECT

string

optional

覆盖智能体追踪的 LangSmith 项目名称。参见使用 LangSmith 追踪。

DEEPAGENTS_CLI_NO_UPDATE_CHECK

string

optional

设置时禁用自动更新检查。

DEEPAGENTS_CLI_SHELL_ALLOW_LIST

string

optional

逗号分隔的允许 shell 命令（或 recommended / all）。

DEEPAGENTS_CLI_USER_ID

string

optional

将用户标识符附加到 LangSmith 追踪元数据。

外部编辑器

按 Ctrl+X 或输入 /editor 在外部编辑器中编写提示。CLI 检查 $VISUAL，然后 $EDITOR，然后回退到 vi（macOS/Linux）或 notepad（Windows）。GUI 编辑器（VS Code、Cursor、Zed、Sublime Text、Windsurf）自动接收 --wait 标志，使 CLI 阻塞直到你关闭文件。

# 在你的 shell 配置文件中设置（~/.zshrc、~/.bashrc 等）
export VISUAL="code"    # GUI 编辑器（自动注入 --wait）
export EDITOR="nvim"    # 终端备用

钩子

钩子允许外部程序对 CLI 生命周期事件做出反应。在 ~/.deepagents/hooks.json 中配置命令，当事件触发时，CLI 会将 JSON 载荷通过管道传递到每个匹配命令的 stdin。钩子以”发出即忘”方式在后台线程中运行 — 它们永远不会阻塞 CLI，失败会被记录但不会中断你的会话。

设置

创建 ~/.deepagents/hooks.json：

{
  "hooks": [
    {
      "command": ["bash", "-c", "cat >> ~/deepagents-events.log"],
      "events": ["session.start", "session.end"]
    }
  ]
}

现在每次会话开始或结束时，CLI 会将事件载荷追加到 ~/deepagents-events.log。

钩子配置

配置文件包含一个 hooks 数组。每个条目有：

command

list[str]

required

要运行的命令和参数。无 shell 展开：如需要请使用 ["bash", "-c", "..."]。

events

list[str]

optional

要订阅的事件名称。省略或留空将接收所有事件。

{
  "hooks": [
    {
      "command": ["python3", "my_handler.py"],
      "events": ["session.start", "task.complete"]
    },
    {
      "command": ["bash", "log_everything.sh"]
    }
  ]
}

上面的第二个钩子没有 events 过滤器，因此它接收 CLI 发出的每个事件。

载荷格式

每个钩子命令在 stdin 上接收一个带有 "event" 键加事件特定字段的 JSON 对象：

{
  "event": "session.start",
  "thread_id": "abc123"
}

事件参考

`session.start`

当智能体会话开始时触发（交互式和非交互式模式）。

thread_id

string

required

会话线程标识符。

`session.end`

当会话退出时触发。

thread_id

string

required

会话线程标识符。

`user.prompt`

在交互模式下当用户提交聊天消息时触发。无额外字段。

`input.required`

当智能体需要人工输入时触发（人机协作中断）。无额外字段。

`permission.request`

在一个或多个工具调用需要用户权限时，在审批对话框之前触发。

tool_names

list[str]

required

请求批准的工具名称。

`tool.error`

当工具调用返回错误时触发。

tool_names

list[str]

required

出错的工具名称。

`task.complete`

当智能体完成当前任务时触发（流式循环结束且无进一步中断）。

thread_id

string

required

会话线程标识符。

`context.compact`

在 CLI 压缩（摘要）对话上下文之前触发。无额外字段。

执行模型

后台线程：钩子子进程通过 asyncio.to_thread 在线程中运行，主事件循环永远不会被阻塞。
并发调度：当多个钩子匹配一个事件时，它们在线程池中并发运行。
5 秒超时：每个命令有 5 秒超时。超时的命令会被终止。
发出即忘：错误按每个钩子捕获并在 debug/warning 级别记录。失败的钩子永远不会使 CLI 崩溃或停顿。
延迟加载：配置文件在第一次事件调度时读取一次并缓存到会话结束。
无 shell 展开：命令直接执行（不通过 shell）。如果你需要管道或变量展开等 shell 功能，请用 ["bash", "-c", "..."] 包装。

钩子示例

将所有事件记录到文件

{
  "hooks": [
    {
      "command": ["bash", "-c", "jq -c . >> ~/.deepagents/hook-events.jsonl"],
      "events": []
    }
  ]
}

任务完成时的桌面通知（macOS）

{
  "hooks": [
    {
      "command": [
        "bash", "-c",
        "osascript -e 'display notification \"Agent finished\" with title \"Deep Agents\"'"
      ],
      "events": ["task.complete"]
    }
  ]
}

Python 处理程序

编写一个从 stdin 读取 JSON 载荷的处理脚本：

my_handler.py

import json
import sys

payload = json.load(sys.stdin)
event = payload["event"]

if event == "session.start":
    print(f"Session started: {payload['thread_id']}", file=sys.stderr)
elif event == "permission.request":
    print(f"Approval needed for: {payload['tool_names']}", file=sys.stderr)

~/.deepagents/hooks.json

{
  "hooks": [
    {
      "command": ["python3", "my_handler.py"],
      "events": ["session.start", "permission.request"]
    }
  ]
}

安全注意事项

钩子遵循与 Git 钩子或 shell 别名相同的信任模型 — 任何能写入 ~/.deepagents/hooks.json 的用户都可以执行任意命令。这是设计如此：

无命令注入：载荷数据仅作为 JSON 流向 stdin，永远不流向命令行参数。json.dumps 处理转义。
默认无 shell：命令以 shell=False 运行，防止 shell 注入。
格式错误的配置：无效的 JSON 或意外类型产生记录的警告，而非安全问题。

仅添加来自你信任的来源的钩子。钩子具有与你的用户账户相同的权限。

连接这些文档到 Claude、VSCode 等，通过 MCP 获取实时答案。

在 GitHub 上编辑此页面或提交问题。

Documentation Index

​提供商凭证

​使用 /auth（推荐）

​环境变量（CI 和无头环境）

​环境变量

​加载顺序和优先级

​DEEPAGENTS_CLI_ 前缀

​示例

​使用 Tavily 启用网页搜索

​配置文件

​默认和最近使用的模型

​默认和最近使用的智能体

​提供商配置

​模型构造参数

​按模型覆盖

​配置文件覆盖（高级）

​使用 --profile-override 的 CLI 配置文件覆盖（高级）

​自定义基础 URL

​兼容 API

​将模型添加到交互式切换器

​任意提供商

​技能额外允许的目录

​主题

​用户自定义主题

​覆盖内置主题颜色

​将主题映射到终端

​选择器快捷键

​常见 TERM_PROGRAM 值

​解析顺序

​自动更新

​托管部署

​CLI 环境变量参考

​外部编辑器

​钩子

​设置

​钩子配置

​载荷格式

​事件参考

​session.start

​session.end

​user.prompt

​input.required

​permission.request

​tool.error

​task.complete

​context.compact

​执行模型

​钩子示例

​安全注意事项

提供商凭证

使用 `/auth`（推荐）

环境变量（CI 和无头环境）

环境变量

加载顺序和优先级

`DEEPAGENTS_CLI_` 前缀

示例

使用 Tavily 启用网页搜索

配置文件

默认和最近使用的模型

默认和最近使用的智能体

提供商配置

模型构造参数

按模型覆盖

配置文件覆盖（高级）

使用 `--profile-override` 的 CLI 配置文件覆盖（高级）

自定义基础 URL

兼容 API

将模型添加到交互式切换器

任意提供商

技能额外允许的目录

主题

用户自定义主题

覆盖内置主题颜色

将主题映射到终端

选择器快捷键

常见 `TERM_PROGRAM` 值

解析顺序

自动更新

托管部署

CLI 环境变量参考

外部编辑器

钩子

设置

钩子配置

载荷格式

事件参考

`session.start`

`session.end`

`user.prompt`

`input.required`

`permission.request`

`tool.error`

`task.complete`

`context.compact`

执行模型

钩子示例

安全注意事项