CLI

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
  api-key     Manage API keys
  code        Open a workspace in VS Code
  completion  Generate the autocompletion script for the specified shell
  cp          Copy files to or from a workspace
  exec        Run a command in a workspace
  help        Help about any command
  login       Authenticate with the platform
  logout      End the profile's session and forget its login
  open        Open a repository, branch, commit or pull request from its URL
  port        Manage exposed ports for workspaces
  project     Manage a team's projects: a repository and the workspace that opens it
  settings    Manage user settings
  share       Manage snapshot sharing
  sign        Sign what only you can: your keyring and your teams' rosters
  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
  trust       What this machine trusts of an installation
  version     Print version information
  whoami      Show current user info
  workspace   Manage workspaces

Flags:
      --config string    config file (default is $HOME/.spin/config.yaml)
  -h, --help             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")

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

• spin admin: Administrative commands
• spin api-key: Manage API keys
• spin code: Open a workspace in VS Code
• spin cp: Copy files to or from a workspace
• spin exec: Run a command in a workspace
• spin login: Authenticate with the platform
• spin logout: End the profile’s session and forget its login
• spin open: Open a repository, branch, commit or pull request from its URL
• spin port: Manage exposed ports for workspaces
• spin project: Manage a team’s projects: a repository and the workspace that opens it
• spin settings: Manage user settings
• spin share: Manage snapshot sharing
• spin sign: Sign what only you can: your keyring and your teams’ rosters
• 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 trust: What this machine trusts of an installation
• spin version: Print version information
• spin whoami: Show current user info
• spin workspace: Manage workspaces