Files
docker-docs/data/sbx_cli/sbx_setup_ssh.yaml
T
2026-09-22 15:27:05 +02:00

36 lines
1.3 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 Unix
socket (OS user boundary) combined with an active Docker login. Sign in first
(sbx login).
usage: sbx setup ssh [flags]
options:
- name: alias
default_value: '*.sbx'
usage: ssh_config Host pattern to write
- 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 client config for the current local app instance