Skip to content

oss(deepagents-cli): clarify CLI is built on SDK, mention non-interactive mode #2985

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Mason Daugherty (mdrxy) merged 1 commit into from
Mar 8, 2026
Merged

oss(deepagents-cli): clarify CLI is built on SDK, mention non-interactive mode #2985

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions src/oss/deepagents/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ We think of `deepagents` as an ["agent harness"](/oss/concepts/products#agent-ha

The `deepagents` library contains:
- **Deep Agents SDK**: A package for building agents that can handle any task
- **Deep Agents CLI**: A terminal coding agent built on top of the `deepagents` package
- [**Deep Agents CLI**](/oss/deepagents/cli): A terminal coding agent built on the Deep Agents SDK

[LangChain](/oss/langchain/) is the framework that provides the core building blocks for your agents.
To learn more about the differences between LangChain, LangGraph, and Deep Agents, see [Frameworks, runtimes, and harnesses](/oss/concepts/products).
Expand Down Expand Up @@ -81,12 +81,13 @@ console.log(
See the [Quickstart](/oss/deepagents/quickstart/) and [Customization guide](/oss/deepagents/customization/) to get started building your own agents and applications with deep agents.

<Tip>
Use [LangSmith](/langsmith/home) to trace requests, debug agent behavior, and evaluate outputs. Set `LANGSMITH_TRACING=true` and your API key to get started.
Use [LangSmith](/langsmith/home) to trace requests, debug agent behavior, and evaluate outputs. Set `LANGSMITH_TRACING=true` and your API key to get started.
</Tip>

## When to use the Deep Agents

Use the **Deep Agents SDK** when you want to build agents that can:

- **Handle complex, multi-step tasks** that require planning and decomposition
- **Manage large amounts of context** through file system tools
- **Swap filesystem backends** to use in-memory state, local disk, durable stores, [sandboxes](/oss/deepagents/sandboxes), or [your own custom backend](/oss/deepagents/backends)
Expand All @@ -101,8 +102,9 @@ For building simpler agents, consider using LangChain's [`create_agent`](/oss/la
For building simpler agents, consider using LangChain's [`createAgent`](/oss/langchain/agents) or building a custom [LangGraph](/oss/langgraph/overview) workflow.
:::

Use the **Deep Agents CLI** when you want to use an interactive deep agent on the command-line for coding or other tasks:
Use the **Deep Agents CLI** when you want a coding agent on the command line, built on the Deep Agents SDK:

- **Run interactively or non-interactively** — use the CLI as a chat-style coding agent, or pipe tasks with `-n` for scriptable, headless execution.
- **Customize** agents with skills and memory.
- **Teach** agents as you use them about your preferences, common patterns, and custom project knowledge.
- **Execute code** on your machine or in sandboxes.
Expand Down