/auth 凭据管理器添加密钥。对于非交互式运行,可通过 dcode auth 或设置 环境变量 管理已存储的密钥。
如果密钥在多个位置设置,请参考 密钥优先级 确认哪个生效。
关于 .env 加载顺序和 DEEPAGENTS_CODE_ 前缀,请查阅 配置。
使用 /auth(推荐)
从任意会话中打开凭据管理器:
Provider row labels
Provider row labels
每行显示提供商名称及其密钥来源:
/auth 提示词包含可选的 基础 URL 字段。留空使用提供商默认端点,或设置自定义端点。基础 URL 会与密钥一同存储。关于端点解析(包括网关)请参考 端点、密钥与网关。
密钥仅限于当前机器的用户账户。Deep Agents Code 仅将密钥传输至配置的提供商 API。
使用 ChatGPT 登录
选择openai_codex 提供商并在 /auth 中启动浏览器登录流程,而非输入 API 密钥,从而使用 OpenAI 模型与 ChatGPT 订阅。重新认证或注销需再次选择 openai_codex。完整流程请参考 使用 ChatGPT 登录(Codex 模型)。
/auth 管理语言模型提供商凭据、Tavily 网页搜索密钥和 LangSmith 追踪密钥。输入 Tavily 密钥可 激活网页搜索,输入 LangSmith 密钥可启用追踪。密钥也可从环境变量读取。可以在 ~/.deepagents/.env 或您的 shell 中设置这些变量。
从 shell 管理凭据(dcode auth)
dcode auth 命令组是 /auth 管理器的脚本化等价物:无需启动图形界面,即可通过脚本管理凭据,适用于 dotfile 初始化、CI/CD 和通过 SSH 在远程机器设置密钥。子命令对应管理器的操作:
set 默认从 stdin 读取密钥,因此密钥不会出现在 shell 历史或 argv 中。可通过管道输入密钥或使用 --from-env VAR 从环境变量复制:
set 不允许在交互式终端运行,避免因等待输入导致进程挂起。需通过 stdin 管道或 --from-env VAR 从环境变量获取密钥。存储的密钥与 /auth 同一存储机制,因此权限警告(例如 auth.json 文件权限问题)会输出至 stderr。dcode auth set 仅管理 API 密钥。openai_codex 提供商使用 ChatGPT 浏览器登录而非 API 密钥,需运行 /auth 并选择 openai_codex 登录。dcode auth remove openai_codex 会注销。环境变量(CI/无界面环境)
对于非交互式运行、CI/CD 流水线或无图形界面环境,需导出提供商的环境变量:.env 文件 中定义。
密钥优先级
当同一提供商的密钥设置在多个位置时,Deep Agents Code 按以下顺序优先使用:DEEPAGENTS_CODE_-前缀环境变量 — 例如DEEPAGENTS_CODE_OPENAI_API_KEY(直接 shell 导出)。DEEPAGENTS_CODE_前缀 是显式覆盖 Deep Agents Code 的密钥的标记。- 应用存储密钥 — 在
/auth凭据管理器中输入的密钥。 - 普通提供商环境变量 — 例如
OPENAI_API_KEY(来自 shell 或.env文件)。
DEEPAGENTS_CODE_-前缀密钥会覆盖应用存储密钥。前缀机制可在单次运行中覆盖已存储密钥,而无需清除原密钥:
OPENAI_API_KEY 共享变量),但不想让 Deep Agents Code 使用。应用存储密钥或 DEEPAGENTS_CODE_-前缀变量可为 Deep Agents Code 提供独立值,同时保留原未前缀变量供其他工具使用,确保两者完全隔离。
每个提供商的 API 密钥及其端点(base_url)均从同一来源解析。关于端点与密钥的解析机制请参考 端点、密钥与网关。
启用 Tavily 网页搜索
内置的web_search 工具使用 Tavily。Deep Agents Code 启动时若未提供密钥会显示 “Web search disabled” 提示。您可在 /auth 凭据管理器](Tavily 作为非模型服务显示)存储密钥,或设置 TAVILY_API_KEY 环境变量。
- Use /auth (recommended)
- Set an environment variable
从 tavily.com 获取密钥(以 选择 Tavily 并粘贴密钥。也可直接通过 “Web search disabled” 提示选择 输入 API 密钥。
tvly- 开头;免费版适用于大多数 Deep Agents Code 使用场景),然后在凭据管理器中存储:参考链接
官方原文:src/oss/deepagents/code/credentials.mdx · 非官方翻译,译文由 AI 生成,以英文原文为准。