Files
docker-docs/data/sbx_cli/sbx.yaml
T
David Karlsson c64e3927ef docs: update Sandboxes for the v0.48.0 CLI refactor (#26314)
## Summary

Update the Sandbox documentation for the v0.48.0 CLI refactor: renamed
flags, settings commands, terminal output, structured output, and
non-interactive confirmations. Add a migration reference for scripts and
CI workflows, with a [**Copy as prompt**
button](https://deploy-preview-26314--docsdocker.netlify.app/ai/sandboxes/workflows/automation/#update-scripts-for-v0480)
that copies agent instructions and the section Markdown.

This PR targets `main` independently of the other PRs in the sbx/v0.48.0
milestone. It keeps the generated reference import separate from
documentation edits:

- Vendor the 120 generated CLI YAML files
- Update command examples and guidance. Historical release notes retain
their original command spellings.

The other milestone PRs cover separate release features; this PR covers
the CLI migration.

@netlify /ai/sandboxes/workflows/automation/

Generated by Codex
2026-10-13 17:18:50 +02:00

52 lines
2.3 KiB
YAML

name: sbx
synopsis: Manage AI coding agent sandboxes.
description: |-
Docker Sandboxes creates isolated sandbox environments for AI agents, powered by Docker.
Run without a command to launch interactive mode, or pass a command for CLI usage.
usage: sbx COMMAND
options:
- name: cloud
default_value: "false"
usage: |
Dispatch to Docker Cloud Sandboxes API instead of local sandboxd (supported by a growing set of verbs — run 'sbx --cloud --help' for the current list)
- name: debug
shorthand: D
default_value: "false"
usage: Enable debug logging
- name: help
shorthand: h
default_value: "false"
usage: help for sbx
see_also:
- sbx attach - Attach to a cloud sandbox, starting it first if it is stopped
- sbx completion - Generate the autocompletion script for the specified shell
- sbx cp - Copy files or directories between a sandbox and the host
- sbx create - Create a sandbox for an agent
- sbx daemon - Manage sandboxd daemon
- sbx diagnose - Diagnose common issues with your sbx installation
- sbx env - (Experimental) Manage sandboxes declaratively from an sbxenv.yaml file
- sbx exec - Execute a command inside a sandbox
- sbx kit - (Experimental) Manage kit artifacts
- sbx login - Sign in to Docker
- sbx logout - Stop running local sandboxes and sign out of Docker
- sbx ls - List sandboxes
- sbx mcp - Manage MCP servers
- sbx move - Move a sandbox between local and cloud
- sbx policy - Manage sandbox policies
- sbx ports - Manage sandbox port publishing
- sbx prune - Remove all stopped sandboxes
- sbx reset - Reset all sandboxes and clean up state
- sbx rm - Remove one or more sandboxes
- sbx run - Run an agent in a sandbox
- sbx secret - Manage stored secrets
- sbx settings - Manage Docker Sandboxes settings
- sbx setup - (Experimental) Detect host configuration and prepare Docker Sandboxes
- sbx skills - (Experimental) Manage skills available in sandboxes
- sbx stop - Stop one or more sandboxes without removing them
- sbx template - Manage sandbox templates
- sbx ttl - Show or extend a cloud sandbox's TTL
- sbx tui - Open the interactive TUI dashboard
- sbx version - Show Docker Sandboxes version information
- sbx volume - Manage persistent volumes (cloud-only)