Skip to content
Spinbox is experimental: APIs change and data may be lost. Status lists what is built and what proves it.

CLI

View Markdown

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

Generated by task reference from spin/cmd/cli at 51f7e0dea.

Installations run Spinbox v20261027.01; the reference is generated from spin v20261114.01 (51f7e0dea). This page as Markdown, for a model or a terminal.