Function●Since v0.0

create_cli_agent

Create a CLI-configured agent with flexible options.

This is the main entry point for creating a deepagents CLI agent, usable both internally and from external code (e.g., benchmarking frameworks).

create_cli_agent(
  model: str | BaseChatModel,
  assistant_id: str,
  *,
  tools: Sequence[BaseTool | Callable | dict[str, Any]] | None = None,
  sandbox: SandboxBackendProtocol | None = None,
  sandbox_type: str | None = None,
  system_prompt: str | None = None,
  auto_approve: bool = False,
  enable_memory: bool = True,
  enable_skills: bool = True,
  enable_shell: bool = True,
  checkpointer: BaseCheckpointSaver | None = None
) -> tuple[Pregel, CompositeBackend]

Parameters

Name	Type	Description
`model`*	`str \| BaseChatModel`	LLM model to use (e.g., `'anthropic:claude-sonnet-4-5-20250929'`)
`assistant_id`*	`str`	Agent identifier for memory/state storage
`tools`	`Sequence[BaseTool \| Callable \| dict[str, Any]] \| None`	Default:`None` Additional tools to provide to agent
`sandbox`	`SandboxBackendProtocol \| None`	Default:`None` Optional sandbox backend for remote execution (e.g., `ModalBackend`). If `None`, uses local filesystem + shell.
`sandbox_type`	`str \| None`	Default:`None` Type of sandbox provider (`'daytona'`, `'langsmith'`, `'modal'`, `'runloop'`). Used for system prompt generation.
`system_prompt`	`str \| None`	Default:`None` Override the default system prompt. If `None`, generates one based on `sandbox_type` and `assistant_id`.
`auto_approve`	`bool`	Default:`False` If `True`, no tools trigger human-in-the-loop interrupts — all calls (shell execution, file writes/edits, web search, URL fetch) run automatically. If `False`, tools pause for user confirmation via the approval menu. See `_add_interrupt_on` for the full list of gated tools.
`enable_memory`	`bool`	Default:`True` Enable `MemoryMiddleware` for persistent memory
`enable_skills`	`bool`	Default:`True` Enable `SkillsMiddleware` for custom agent skills
`enable_shell`	`bool`	Default:`True` Enable shell execution via `LocalShellBackend` (only in local mode). When enabled, the `execute` tool is available.
`checkpointer`	`BaseCheckpointSaver \| None`	Default:`None` Optional checkpointer for session persistence. If `None`, uses `InMemorySaver` (no persistence across CLI invocations).

View source on GitHub

create_cli_agent( model: str | BaseChatModel, assistant_id: str, *, tools: Sequence[BaseTool | Callable | dict[str, Any]] | None = None, sandbox: SandboxBackendProtocol | None = None, sandbox_type: str | None = None, system_prompt: str | None = None, auto_approve: bool = False, enable_memory: bool = True, enable_skills: bool = True, enable_shell: bool = True, checkpointer: BaseCheckpointSaver | None = None ) -> tuple[Pregel, CompositeBackend]

Parameters

Name	Type	Description
`model`*	`str \| BaseChatModel`	LLM model to use (e.g., `'anthropic:claude-sonnet-4-5-20250929'`)
`assistant_id`*	`str`	Agent identifier for memory/state storage
`tools`	`Sequence[BaseTool \| Callable \| dict[str, Any]] \| None`	Default:`None` Additional tools to provide to agent
`sandbox`	`SandboxBackendProtocol \| None`	Default:`None` Optional sandbox backend for remote execution (e.g., `ModalBackend`). If `None`, uses local filesystem + shell.
`sandbox_type`	`str \| None`	Default:`None` Type of sandbox provider (`'daytona'`, `'langsmith'`, `'modal'`, `'runloop'`). Used for system prompt generation.
`system_prompt`	`str \| None`	Default:`None` Override the default system prompt. If `None`, generates one based on `sandbox_type` and `assistant_id`.
`auto_approve`	`bool`	Default:`False` If `True`, no tools trigger human-in-the-loop interrupts — all calls (shell execution, file writes/edits, web search, URL fetch) run automatically. If `False`, tools pause for user confirmation via the approval menu. See `_add_interrupt_on` for the full list of gated tools.
`enable_memory`	`bool`	Default:`True` Enable `MemoryMiddleware` for persistent memory
`enable_skills`	`bool`	Default:`True` Enable `SkillsMiddleware` for custom agent skills
`enable_shell`	`bool`	Default:`True` Enable shell execution via `LocalShellBackend` (only in local mode). When enabled, the `execute` tool is available.
`checkpointer`	`BaseCheckpointSaver \| None`	Default:`None` Optional checkpointer for session persistence. If `None`, uses `InMemorySaver` (no persistence across CLI invocations).

create_cli_agent

Parameters

LangChain Assistant

Menu

create_cli_agent

Parameters