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

spin open

View Markdown
Open what a forge's URL names in a workspace of the project that has the repository, and
connect to it: the repository at the project's ref, a branch (/tree/<branch>), a commit
(/commit/<sha>) or a pull request (/pull/<n>), checked out as pr-<n>. The project is found by
its repository among the projects you see; with more than one, --project says which. The
workspace is made in --team, or your personal team. A repository no project has is one to make a
project of first ('spin project create').
The workspace is the project's shape, sized by its preset unless --preset names another. It ends
in 'spin ssh', which logs in with a key you added ('spin ssh-key add'), unless --no-connect.
Examples:
spin open https://github.com/spin-stack/qboot
spin open https://github.com/spin-stack/qboot/pull/7
spin open https://github.com/spin-stack/qboot/tree/release/2 --team /engineering
Usage:
spin open <url> [flags]
Flags:
-h, --help[=true|false] help for open
--name string Workspace name (auto-generated if empty)
--no-connect[=true|false] Create the workspace and print it, without connecting
--preset string The preset it is sized by, by name (default: the project's)
--project string The project to open, by slug, when more than one has the repository
--team string The team the workspace is made in, by id, path or me (your personal team if empty)
--timeout duration How long --wait waits; by default, until the control plane gives up on it
--wait[=true|false] Return once the workspace is running, with --no-connect
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

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.