mirror of
https://github.com/docker/docs.git
synced 2026-11-04 10:01:00 +00:00
David Karlsson
c64e3927ef
## 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
71 lines
2.6 KiB
YAML
71 lines
2.6 KiB
YAML
name: sbx prune
|
|
synopsis: Remove all stopped sandboxes
|
|
description: |-
|
|
Remove all stopped sandboxes and their associated resources.
|
|
|
|
Only stopped sandboxes are candidates — a running sandbox is never removed,
|
|
which makes this safe to run habitually. Stop a sandbox first with
|
|
"sbx stop" if you want it pruned. To remove a specific sandbox regardless of
|
|
state, use "sbx rm SANDBOX".
|
|
|
|
Use --filter until=TIMESTAMP to narrow the set to sandboxes that stopped before
|
|
TIMESTAMP. The value can be an RFC 3339 timestamp, Unix timestamp, or Go duration
|
|
relative to now (e.g. until=168h keeps anything stopped within the last week).
|
|
A sandbox whose stop time the daemon cannot report is left alone, since how long
|
|
it has been stopped cannot be established.
|
|
|
|
Use --dry-run to list what would be removed without removing anything, and
|
|
--format json or --format yaml with it for machine-readable output.
|
|
|
|
Pruning requires confirmation; use --force to skip the confirmation prompt
|
|
(for non-interactive scripts) and to remove a sandbox that is in use (e.g. an
|
|
open SSH connection). This action cannot be undone.
|
|
|
|
Secrets scoped to each successfully pruned sandbox are also deleted.
|
|
|
|
Local-only: cloud sandboxes expire via their TTL.
|
|
usage: sbx prune [flags]
|
|
options:
|
|
- name: dry-run
|
|
default_value: "false"
|
|
usage: |
|
|
List the sandboxes that would be removed without removing them
|
|
- name: filter
|
|
default_value: '[]'
|
|
usage: |
|
|
Filter candidates (supported: until=TIMESTAMP — stopped before TIMESTAMP)
|
|
- name: force
|
|
shorthand: f
|
|
default_value: "false"
|
|
usage: |
|
|
Skip confirmation prompts and remove even if in use (e.g. an open SSH connection)
|
|
- name: format
|
|
usage: 'Output format: table, json or yaml'
|
|
- name: help
|
|
shorthand: h
|
|
default_value: "false"
|
|
usage: help for prune
|
|
- name: json
|
|
default_value: "false"
|
|
usage: Output in JSON format
|
|
inherited_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
|
|
example: |4-
|
|
# Show what would be removed
|
|
sbx prune --dry-run
|
|
|
|
# Remove without asking
|
|
sbx prune --force
|
|
|
|
# Only sandboxes stopped before a point in time
|
|
sbx prune --filter until=2026-01-01T00:00:00Z
|
|
see_also:
|
|
- sbx - Manage AI coding agent sandboxes.
|