# spin ssh

**Spinbox is experimental: APIs change and data may be lost.** What is built and what proves it is on [Status](https://docs.spinbox.dev/reference/status.md); what Spinbox does not do is on [Limitations](https://docs.spinbox.dev/overview/limitations.md).

> spin ssh: SSH into a workspace.

<!-- Generated by tools/refgen from spin:cmd/cli. Edit the source, not this file. -->

```
Connect to a workspace via SSH.

The connection is tunneled through the platform using WebSocket,
so no direct network access to the workspace is required.

It runs your ssh, which has to be OpenSSH 9.9 or newer: a workspace accepts only the
post-quantum key exchange mlkem768x25519-sha256, and an older ssh is refused before anything
is asked of the workspace.

Examples:
  spin ssh my-workspace
  spin ssh my-workspace -- -L 8080:localhost:80

Usage:
  spin ssh <workspace> [ssh-argument...] [flags]

Flags:
  -h, --help[=true|false]    help for ssh
  -i, --identity string      Identity file (private key)
      --start[=true|false]   Start the workspace first if it is stopped
      --timeout duration     How long to wait for the workspace to be running; by default, until the control plane gives up on it
  -u, --user string          SSH username (certificates are issued for root today) (default "root")

Global Flags:
      --config string        config file (default is $HOME/.spin/config.yaml)
  -o, --output string        text for a person, or json: one document of what the API answered, and no prose (default "text")
      --profile string       named profile to use; SPIN_PROFILE names it when this flag does not (default "default")
      --traceparent string   the W3C traceparent of the span this command is part of; its own span is sent to the installation unless the profile says telemetry: false
```
