快速入门
安装并启动
添加提供商凭证
该 CLI 可与任何支持工具调用的大语言模型(LLM)配合使用。使用
/auth 命令为你选择的提供商设置 API 密钥——详情请参阅提供商凭证了解完整流程和存储细节。有关其他提供商和无头运行,请参阅提供商。网络搜索使用 Tavily,不通过
/auth 配置。如果你在启动时看到 “Web search disabled — TAVILY_API_KEY is not set”,请在 ~/.deepagents/.env 中添加 TAVILY_API_KEY=tvly-... 并运行 /reload(或重启)。参阅启用 Tavily 网络搜索。给智能体分配任务
启用追踪(可选)
要在 LangSmith 中记录智能体操作、工具调用和决策,请将以下内容添加到 更多详情和用法,请参阅使用 LangSmith 追踪。
~/.deepagents/.env 或在 shell 中导出变量:~/.deepagents/.env
深度智能体 CLI 不正式支持 Windows。Windows 用户可以尝试在 Windows Subsystem for Linux (WSL) 下运行。
功能
深度智能体 CLI 具有以下内置功能:- 文件操作 - 读取、写入和编辑文件,使智能体能够管理和修改代码及文档。
- Shell 执行 - 执行命令以运行测试、构建项目、管理依赖和操作版本控制。
- 远程沙箱 - 在 LangSmith、Daytona、Modal、Runloop 或 AgentCore 中运行智能体工具,而非在本地机器上。链接页面涵盖提供商安装、凭证、沙箱标志(
--sandbox、--sandbox-id、--sandbox-setup)和设置脚本。 - 网络搜索 - 搜索网络获取最新信息和文档。需要在
TAVILY_API_KEY中配置 Tavily API 密钥。 - HTTP 请求 - 向 API 和外部服务发起 HTTP 请求,用于数据获取和集成任务。
- 任务规划和追踪 - 将复杂任务分解为离散步骤并跟踪进度。
- 子智能体 - 使用
task工具委派工作。在 CLI 中,将自定义子智能体定义为AGENTS.md文件;链接页面涵盖路径、frontmatter 和示例。 - 记忆存储和检索 - 跨会话存储和检索信息,使智能体能够记住项目规范和学到的模式。
- 上下文压缩和卸载 - 摘要旧的对话消息并将原始内容卸载到存储中,在长会话期间释放上下文窗口空间。
- 人机协作 - 需要人工审批敏感的工具操作。
- 技能 - 使用自定义专业知识和指令扩展智能体能力。
- MCP 工具 - 从模型上下文协议服务器加载外部工具。
- 追踪 - 在 LangSmith 中追踪智能体操作,用于可观测性和调试。
完整内置工具列表
完整内置工具列表
内置工具
智能体配备以下内置工具,无需配置即可使用:1:可能具有破坏性的操作在执行前需要用户批准。要跳过人工审批,可以切换自动批准(shift+tab)或使用以下选项启动:
在非交互模式下(通过
-n 或管道 stdin)运行 CLI 时,即使使用 -y/--auto-approve,shell 执行默认也是禁用的。使用 -S/--shell-allow-list 允许特定命令(例如 -S "pytest,git,make"),recommended 表示安全默认值,或 all 允许任何命令。也支持 DEEPAGENTS_CLI_SHELL_ALLOW_LIST 环境变量。更多详情请参阅非交互模式和管道。/conversation_history/{thread_id}.md),用摘要替换上下文中的内容。如有需要,智能体仍可从卸载的文件中检索完整历史。compact_conversation 工具允许智能体(或你)按需触发卸载。作为工具调用时,默认需要用户批准。命令参考
命令行选项
命令行选项
CLI 命令
CLI 命令
所有管理子命令都支持
--json 以获取机器可读输出。详情请参阅命令行选项。破坏性命令(agents reset、skills delete、threads delete)支持 --dry-run 来预览操作结果而不实际执行。在 JSON 模式下,--dry-run 返回相同的信封并带有 dry_run: true 字段。配置
完整参考——包括config.toml 模式、提供商参数、配置覆盖和钩子配置——请参阅配置。
CLI 将所有配置存储在 ~/.deepagents/ 下。在该目录中,每个智能体有自己的子目录(默认为 agent):
交互模式
像在聊天界面中一样自然输入。 智能体将使用其内置工具、技能和记忆来帮助你完成任务。斜杠命令
斜杠命令
在 CLI 会话中使用以下命令:
/model- 切换模型或打开交互式模型选择器。/agents- 在预配置的智能体之间热切换,无需重新启动。详情参阅命令参考/auth- 管理模型提供商的已存储 API 密钥。详情参阅提供商凭证/remember [context]- 回顾对话并更新记忆和技能。可选传入额外上下文/skill:<name> [args]- 按名称直接调用技能。技能的SKILL.md指令会与你提供的任何参数一起注入提示中/skill-creator [args]- 创建有效智能体技能的指南/offload(别名/compact)- 通过将消息卸载到存储并用摘要占位符替换来释放上下文窗口空间。如有需要,智能体可以从卸载的文件中检索完整历史/tokens- 显示当前上下文窗口 Token 使用情况明细/clear- 清除对话历史并开始新线程/threads- 浏览并恢复之前的对话线程/mcp- 显示活跃的 MCP 服务器和工具/reload- 重新读取.env文件、刷新配置并重新发现技能,无需重启。对话状态被保留。参阅DEEPAGENTS_CLI_前缀了解覆盖行为/theme- 打开交互式主题选择器切换颜色主题。提供内置主题以及任何用户定义主题/update- 内联检查并安装 CLI 更新。检测你的安装方式(uv、Homebrew、pip)并运行相应的升级命令/auto-update- 开启或关闭自动更新/trace- 在 LangSmith 中打开当前线程(需要LANGSMITH_API_KEY)/editor- 在外部编辑器中打开当前提示($VISUAL/$EDITOR)。参阅外部编辑器/changelog- 在浏览器中打开 CLI 更新日志/docs- 在浏览器中打开文档/feedback- 打开 GitHub issues 页面提交 bug 报告或功能请求/version- 显示已安装的deepagents-cli和 SDK 版本/help- 显示帮助和可用命令/quit- 退出 CLI
Shell 命令
Shell 命令
输入
! 进入 shell 模式,然后输入你的命令。键盘快捷键
键盘快捷键
通用
非交互模式和管道
使用-n 运行单个任务,无需启动交互式 UI:
-n 或 -m 结合时,管道内容出现在前面,然后是你传递给标志的文本。
最大管道输入大小为 10 MiB。
-S/--shell-allow-list 启用特定命令(例如 -S "pytest,git,make"),recommended 表示安全默认值,或 all 允许任何命令。
使用 `--max-turns` 限制回合数
使用 `--max-turns` 限制回合数
在 CI/CD 管道中,长时间运行或行为异常的智能体可能会无限循环。
--max-turns N 为操作者提供了硬性上限,无需触及 SDK 内部机制:N 必须是正整数,并覆盖内部安全默认值(否则会限制失控循环)。超出预算时以代码 124 退出(与 GNU timeout 一致),以便 CI 能区分预算超限和一般故障。需要 -n 或管道 stdin;否则以代码 2 退出。干净输出和缓冲
干净输出和缓冲
使用 在非交互模式下,智能体被指示做出合理假设并自主推进,而非提出澄清问题。它还倾向于使用非交互式命令变体(例如
-q 获取适合管道的干净输出,使用 --no-stream 缓冲完整响应(而非流式输出)后再写入 stdout:npm init -y、apt-get install -y)。Shell 执行示例
Shell 执行示例
使用 LangSmith 追踪
启用 LangSmith 追踪,在 LangSmith 项目中查看智能体操作、工具调用和决策。 将追踪密钥添加到~/.deepagents/.env,这样每个会话都会启用追踪,无需每个 shell 都导出:
~/.deepagents/.env
.env 文件。参阅环境变量了解完整的加载顺序。
你也可以将这些设置为 shell 环境变量。Shell 导出始终优先于 .env 值,因此这是临时覆盖或测试的好选择:
将智能体追踪与应用追踪分开
将智能体追踪与应用追踪分开
当从 LangChain 应用中以编程方式调用 CLI(例如在非交互模式下作为子进程)时,你的应用和 CLI 都会产生 LangSmith 追踪。默认情况下,它们都进入同一个项目。要将 CLI 追踪发送到专用项目,请设置 然后为父应用的追踪配置 这样可以保持应用级可观测性的整洁,同时仍在单独的项目中捕获智能体的内部执行。你还可以使用
DEEPAGENTS_CLI_LANGSMITH_PROJECT:~/.deepagents/.env
LANGSMITH_PROJECT:~/.deepagents/.env
DEEPAGENTS_CLI_ 前缀将 LangSmith 凭证限定到 CLI(例如 DEEPAGENTS_CLI_LANGSMITH_API_KEY)。/trace 打印 URL 并在浏览器中打开。
连接这些文档 到 Claude、VSCode 等工具,通过 MCP 获取实时解答。


