# 沙箱 CLI
管理基于 Docker 的沙箱容器，用于隔离智能体执行。
# 概述
OpenSoul 可以在隔离的 Docker 容器中运行智能体以确保安全。sandbox 命令帮助你管理这些容器，特别是在更新或配置更改后。
# 命令
# opensoul sandbox explain
检查生效的沙箱模式/作用域/工作区访问权限、沙箱工具策略和提权门控（附带修复配置的键路径）。
bash
opensoul sandbox explain
opensoul sandbox explain --session agent:main:main
opensoul sandbox explain --agent work
opensoul sandbox explain --json# opensoul sandbox list
列出所有沙箱容器及其状态和配置。
bash
opensoul sandbox list
opensoul sandbox list --browser # List only browser containers
opensoul sandbox list --json # JSON output输出包括：
- 容器名称和状态（运行中/已停止）
- Docker 镜像及其是否与配置匹配
- 创建时间
- 空闲时间（自上次使用以来的时间）
- 关联的会话/智能体
# opensoul sandbox recreate
移除沙箱容器以强制使用更新的镜像/配置重新创建。
bash
opensoul sandbox recreate --all # Recreate all containers
opensoul sandbox recreate --session main # Specific session
opensoul sandbox recreate --agent mybot # Specific agent
opensoul sandbox recreate --browser # Only browser containers
opensoul sandbox recreate --all --force # Skip confirmation选项：
--all：重新创建所有沙箱容器--session <key>：重新创建特定会话的容器--agent <id>：重新创建特定智能体的容器--browser：仅重新创建浏览器容器--force：跳过确认提示
重要： 容器会在智能体下次使用时自动重新创建。
# 使用场景
# 更新 Docker 镜像后
bash
# Pull new image
docker pull opensoul-sandbox:latest
docker tag opensoul-sandbox:latest opensoul-sandbox:bookworm-slim
# Update config to use new image
# Edit config: agents.defaults.sandbox.docker.image (or agents.list[].sandbox.docker.image)
# Recreate containers
opensoul sandbox recreate --all# 更改沙箱配置后
bash
# Edit config: agents.defaults.sandbox.* (or agents.list[].sandbox.*)
# Recreate to apply new config
opensoul sandbox recreate --all# 更改 setupCommand 后
bash
opensoul sandbox recreate --all
# or just one agent:
opensoul sandbox recreate --agent family# 仅针对特定智能体
bash
# Update only one agent's containers
opensoul sandbox recreate --agent alfred# 为什么需要这个？
问题： 当你更新沙箱 Docker 镜像或配置时：
- 现有容器继续使用旧设置运行
- 容器仅在空闲 24 小时后才被清理
- 经常使用的智能体会无限期保持旧容器运行
解决方案： 使用 opensoul sandbox recreate 强制移除旧容器。它们会在下次需要时自动使用当前设置重新创建。
提示：优先使用 opensoul sandbox recreate 而不是手动 docker rm。它使用 Gateway 网关的容器命名规则，避免在作用域/会话键更改时出现不匹配。
# 配置
沙箱设置位于 ~/.opensoul/opensoul.json 的 agents.defaults.sandbox 下（每个智能体的覆盖设置在 agents.list[].sandbox 中）：
jsonc
{
"agents": {
"defaults": {
"sandbox": {
"mode": "all", // off, non-main, all
"scope": "agent", // session, agent, shared
"docker": {
"image": "opensoul-sandbox:bookworm-slim",
"containerPrefix": "opensoul-sbx-",
// ... more Docker options
},
"prune": {
"idleHours": 24, // Auto-prune after 24h idle
"maxAgeDays": 7, // Auto-prune after 7 days
},
},
},
},
}