mirror of
https://github.com/docker/docs.git
synced 2026-10-23 18:09:02 +03:00
38 lines
1.4 KiB
YAML
38 lines
1.4 KiB
YAML
name: sbx attach
|
|
synopsis: |
|
|
Attach to a cloud sandbox, starting it first if it is stopped
|
|
description: |-
|
|
Attach an interactive terminal session to a cloud sandbox.
|
|
|
|
SANDBOX is the cloud sandbox ID (sbx_*) or name from "sbx --cloud ls".
|
|
|
|
Opens a PTY-backed exec session against the sandbox's agent process. The
|
|
sandbox must already exist; a stopped one is started first. Use
|
|
`sbx --cloud run` to create a sandbox and attach in one step.
|
|
|
|
Only supported with --cloud. See https://docs.docker.com/ai/sandboxes/ for the cloud sandbox model.
|
|
usage: sbx attach SANDBOX [flags]
|
|
options:
|
|
- name: detach-keys
|
|
usage: |
|
|
Override the detach gesture that leaves the session running (Docker-style, e.g. "ctrl-\", "ctrl-x,ctrl-d"). Default: Ctrl-\. Use this when the default collides with an agent's keymap (cloud only).
|
|
- name: help
|
|
shorthand: h
|
|
default_value: "false"
|
|
usage: help for attach
|
|
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-
|
|
# Attach to a sandbox by ID or name
|
|
sbx --cloud attach sbx_abc123
|
|
sbx --cloud attach claude/my-sandbox
|
|
see_also:
|
|
- sbx - Manage AI coding agent sandboxes.
|