Skip to content

Sandbox CLI

Sandbox CLI

Manage Docker-based sandbox containers for isolated agent execution.

Overview

AgenticFlow Enterprise can run agents in isolated Docker containers for security. The sandbox commands help you manage these containers, especially after updates or configuration changes.

Commands

agenticflow-enterprise sandbox explain

Inspect the effective sandbox mode/scope/workspace access, sandbox tool policy, and elevated gates (with fix-it config key paths).

Terminal window
agenticflow-enterprise sandbox explain
agenticflow-enterprise sandbox explain --session agent:main:main
agenticflow-enterprise sandbox explain --agent work
agenticflow-enterprise sandbox explain --json

agenticflow-enterprise sandbox list

List all sandbox containers with their status and configuration.

Terminal window
agenticflow-enterprise sandbox list
agenticflow-enterprise sandbox list --browser # List only browser containers
agenticflow-enterprise sandbox list --json # JSON output

Output includes:

  • Container name and status (running/stopped)
  • Docker image and whether it matches config
  • Age (time since creation)
  • Idle time (time since last use)
  • Associated session/agent

agenticflow-enterprise sandbox recreate

Remove sandbox containers to force recreation with updated images/config.

Terminal window
agenticflow-enterprise sandbox recreate --all # Recreate all containers
agenticflow-enterprise sandbox recreate --session main # Specific session
agenticflow-enterprise sandbox recreate --agent mybot # Specific agent
agenticflow-enterprise sandbox recreate --browser # Only browser containers
agenticflow-enterprise sandbox recreate --all --force # Skip confirmation

Options:

  • --all: Recreate all sandbox containers
  • --session <key>: Recreate container for specific session
  • --agent <id>: Recreate containers for specific agent
  • --browser: Only recreate browser containers
  • --force: Skip confirmation prompt

Important: Containers are automatically recreated when the agent is next used.

Use Cases

After updating Docker images

Terminal window
# Pull new image
docker pull agenticflow-enterprise-sandbox:latest
docker tag agenticflow-enterprise-sandbox:latest agenticflow-enterprise-sandbox:bookworm-slim
# Update config to use new image
# Edit config: agents.defaults.sandbox.docker.image (or agents.list[].sandbox.docker.image)
# Recreate containers
agenticflow-enterprise sandbox recreate --all

After changing sandbox configuration

Terminal window
# Edit config: agents.defaults.sandbox.* (or agents.list[].sandbox.*)
# Recreate to apply new config
agenticflow-enterprise sandbox recreate --all

After changing setupCommand

Terminal window
agenticflow-enterprise sandbox recreate --all
# or just one agent:
agenticflow-enterprise sandbox recreate --agent family

For a specific agent only

Terminal window
# Update only one agent's containers
agenticflow-enterprise sandbox recreate --agent alfred

Why is this needed?

Problem: When you update sandbox Docker images or configuration:

  • Existing containers continue running with old settings
  • Containers are only pruned after 24h of inactivity
  • Regularly-used agents keep old containers running indefinitely

Solution: Use agenticflow-enterprise sandbox recreate to force removal of old containers. They’ll be recreated automatically with current settings when next needed.

Tip: prefer agenticflow-enterprise sandbox recreate over manual docker rm. It uses the Gateway’s container naming and avoids mismatches when scope/session keys change.

Configuration

Sandbox settings live in ~/.agenticflow-enterprise/agenticflow-enterprise.json under agents.defaults.sandbox (per-agent overrides go in agents.list[].sandbox):

{
"agents": {
"defaults": {
"sandbox": {
"mode": "all", // off, non-main, all
"scope": "agent", // session, agent, shared
"docker": {
"image": "agenticflow-enterprise-sandbox:bookworm-slim",
"containerPrefix": "agenticflow-enterprise-sbx-",
// ... more Docker options
},
"prune": {
"idleHours": 24, // Auto-prune after 24h idle
"maxAgeDays": 7, // Auto-prune after 7 days
},
},
},
},
}

See Also

Last updated: