1
0
mirror of https://github.com/docker/docs.git synced 2026-10-23 18:09:02 +03:00
Files
docs/data/sbx_cli/sbx_setup.yaml
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

31 lines
1.2 KiB
YAML

name: sbx setup
synopsis: |
Detect host configuration and prepare Docker Sandboxes
experimental: true
description: |-
Detect what is already configured on your host and prepare Docker Sandboxes.
Agent secrets are detected from the built-in agent kit specs and the
env vars set on this host, and accepted secrets are imported into the global
secrets store (the same store as "sbx secret set"). Setup can enable SSH-agent
forwarding using each client's SSH_AUTH_SOCK, or the native Windows OpenSSH
agent pipe when that variable is unset. A fixed endpoint can also be configured.
usage: sbx setup [COMMAND]
options:
- name: help
shorthand: h
default_value: "false"
usage: help for setup
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
see_also:
- sbx - Manage AI coding agent sandboxes.
- sbx setup ssh - Set up SSH client config for the sandbox endpoint