快速开始
安装和启动
添加提供商凭据
CLI 可与任何支持工具调用的 LLM 配合使用。使用
/auth 命令为所选提供商设置 API 密钥——有关完整流程和存储详情,请参阅提供商凭据。有关其他提供商和无头运行,请参阅提供商。网络搜索使用 Tavily,不通过
/auth 配置。如果启动时看到”Web search disabled — TAVILY_API_KEY is not set”,请将 TAVILY_API_KEY=tvly-... 添加到 ~/.deepagents/.env 并运行 /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)或使用该选项启动:
在非交互模式下运行 CLI(通过
-n 或管道输入的 stdin)时,即使使用 -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_ 前缀(例如 DEEPAGENTS_CLI_LANGSMITH_API_KEY)将 LangSmith 凭据限定到 CLI。/trace 打印 URL 并在浏览器中打开。
将这些文档连接到 Claude、VSCode 等,通过 MCP 获取实时答案。


