mirror of
https://github.com/docker/docs.git
synced 2026-10-23 18:09:02 +03:00
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
41 lines
1.6 KiB
YAML
41 lines
1.6 KiB
YAML
name: sbx setup ssh
|
|
synopsis: Set up SSH client config for the sandbox endpoint
|
|
experimental: true
|
|
description: |-
|
|
Write a generated SSH config + known_hosts and include it from
|
|
~/.ssh/config so "ssh <name>.sbx" connects with no prompts. Named app instances
|
|
use "ssh <name>.sbx-<app>" instead. Re-run any time; it's idempotent.
|
|
|
|
No SSH client key is needed — authentication is handled by the daemon's local
|
|
socket or named pipe (OS user boundary) combined with an active Docker login. Sign in first
|
|
(sbx login). On macOS and Windows, use --auto-create to install the fixed codex.sbx and
|
|
claude.sbx desktop profiles. Sandboxes are created with the standard resource defaults.
|
|
usage: sbx setup ssh [flags]
|
|
options:
|
|
- name: alias
|
|
default_value: '*.sbx'
|
|
usage: ssh_config Host pattern to write
|
|
- name: auto-create
|
|
default_value: "false"
|
|
usage: |
|
|
enable managed Codex and Claude Desktop profiles on macOS and Windows
|
|
- name: help
|
|
shorthand: h
|
|
default_value: "false"
|
|
usage: help for ssh
|
|
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-
|
|
sbx setup ssh
|
|
ssh my-sandbox.sbx -- echo hello
|
|
see_also:
|
|
- sbx setup - (Experimental) Detect host configuration and prepare Docker Sandboxes
|
|
- sbx setup ssh remove - Remove SSH config and desktop targets; keep sandboxes
|