# spin ssh

**Spinbox is experimental: APIs change and data may be lost.** What is built and what proves it is on [Status](https://spin-stack.github.io/website/reference/status.md); what Spinbox does not do is on [Limitations](https://spin-stack.github.io/website/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.

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

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

Flags:
  -h, --help               help for ssh
  -i, --identity string    Identity file (private key)
      --start              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")
```