# CLI

**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).

> Every command of the spin CLI, as its own --help says it: workspaces, snapshots, ports, keys, teams and administration.

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

The `spin` command line, one page per command. Each page is the command's own `--help`, and the help of every command under it.

```
spin is a CLI tool for managing workspaces on the
spin platform. Create, start, stop, and share workspaces with ease.

Usage:
  spin [flags]
  spin [command]

Available Commands:
  admin       Administrative commands
  agent       Run T3 Code in a workspace and use it from this computer
  api-key     Manage API keys
  code        Open a workspace in your editor over SSH
  completion  Generate the autocompletion script for the specified shell
  cp          Copy files to or from a workspace
  exec        Run a command in a workspace
  git         Your accounts on forges: GitHub, connected through this installation's app
  help        Help about any command
  login       Authenticate with the platform
  logout      End the profile's session and forget its login
  mcp         Serve the Model Context Protocol on stdin and stdout, for an agent to work in workspaces
  open        Open a repository, branch, commit or pull request from its URL
  port        Manage exposed ports for workspaces
  project     Manage projects: a repository and the workspace that opens it
  settings    Manage user settings
  share       Manage snapshot sharing
  smoke       Check an installation does what its API promises, with a workspace of its own
  snapshot    Take, list and delete a workspace's snapshots
  ssh         SSH into a workspace
  ssh-config  Make every workspace reachable with plain ssh, as the host spin.<workspace>
  ssh-key     Manage SSH keys
  team        Manage teams
  update      Install the CLI of the release your installation runs
  version     Print version information
  vscode      The Spinbox extension for VS Code
  whoami      Show current user info
  workspace   Manage workspaces

Flags:
      --config string        config file (default is $HOME/.spin/config.yaml)
  -h, --help[=true|false]    help for spin
  -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

Use "spin [command] --help" for more information about a command.
```

- [`spin admin`](https://docs.spinbox.dev/reference/cli/admin.md): Administrative commands
- [`spin agent`](https://docs.spinbox.dev/reference/cli/agent.md): Run T3 Code in a workspace and use it from this computer
- [`spin api-key`](https://docs.spinbox.dev/reference/cli/api-key.md): Manage API keys
- [`spin code`](https://docs.spinbox.dev/reference/cli/code.md): Open a workspace in your editor over SSH
- [`spin cp`](https://docs.spinbox.dev/reference/cli/cp.md): Copy files to or from a workspace
- [`spin exec`](https://docs.spinbox.dev/reference/cli/exec.md): Run a command in a workspace
- [`spin git`](https://docs.spinbox.dev/reference/cli/git.md): Your accounts on forges: GitHub, connected through this installation's app
- [`spin login`](https://docs.spinbox.dev/reference/cli/login.md): Authenticate with the platform
- [`spin logout`](https://docs.spinbox.dev/reference/cli/logout.md): End the profile's session and forget its login
- [`spin mcp`](https://docs.spinbox.dev/reference/cli/mcp.md): Serve the Model Context Protocol on stdin and stdout, for an agent to work in workspaces
- [`spin open`](https://docs.spinbox.dev/reference/cli/open.md): Open a repository, branch, commit or pull request from its URL
- [`spin port`](https://docs.spinbox.dev/reference/cli/port.md): Manage exposed ports for workspaces
- [`spin project`](https://docs.spinbox.dev/reference/cli/project.md): Manage projects: a repository and the workspace that opens it
- [`spin settings`](https://docs.spinbox.dev/reference/cli/settings.md): Manage user settings
- [`spin share`](https://docs.spinbox.dev/reference/cli/share.md): Manage snapshot sharing
- [`spin smoke`](https://docs.spinbox.dev/reference/cli/smoke.md): Check an installation does what its API promises, with a workspace of its own
- [`spin snapshot`](https://docs.spinbox.dev/reference/cli/snapshot.md): Take, list and delete a workspace's snapshots
- [`spin ssh`](https://docs.spinbox.dev/reference/cli/ssh.md): SSH into a workspace
- [`spin ssh-config`](https://docs.spinbox.dev/reference/cli/ssh-config.md): Make every workspace reachable with plain ssh, as the host spin.<workspace>
- [`spin ssh-key`](https://docs.spinbox.dev/reference/cli/ssh-key.md): Manage SSH keys
- [`spin team`](https://docs.spinbox.dev/reference/cli/team.md): Manage teams
- [`spin update`](https://docs.spinbox.dev/reference/cli/update.md): Install the CLI of the release your installation runs
- [`spin version`](https://docs.spinbox.dev/reference/cli/version.md): Print version information
- [`spin vscode`](https://docs.spinbox.dev/reference/cli/vscode.md): The Spinbox extension for VS Code
- [`spin whoami`](https://docs.spinbox.dev/reference/cli/whoami.md): Show current user info
- [`spin workspace`](https://docs.spinbox.dev/reference/cli/workspace.md): Manage workspaces
