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

spin project

View Markdown
A project is a repository and the shape of the workspace that opens it: the image, the preset
and the network policies, and the ref it opens at. 'spin workspace create --project <slug>' makes a
workspace of that shape, whose guest clones the repository into /workspace/<repository name> and
runs the repository's own .spin.yaml tasks there.
Projects are the installation's. Whoever makes one is its admin, and it is seen by everybody until
its admins share it with only some people and teams ('spin project share'). A private repository
on GitHub is cloned with the workspace owner's own GitHub account, connected in the dashboard
(Settings → Git); the URL carries no credential.
Usage:
spin project [flags]
spin project [command]
Available Commands:
create Make a project
delete Delete a project; one with a workspace open on it is refused
list List the projects you see
prebuild Build one of a project's prebuild refs now
prebuilds List a project's prebuilds, newest first
share Say who sees a project and who administers it, whole
update Save a project whole: every flag is what it becomes
Flags:
-h, --help[=true|false] help for project
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
Use "spin project [command] --help" for more information about a command.
Make a project: its repository, the ref it opens at, and the shape of the workspace that opens
it. You are its admin, and everybody sees it until you share it otherwise. An installation may keep
making projects to its administrators.
Example:
spin project create --name qboot --repository https://github.com/spin-stack/qboot --ref master --preset large
Usage:
spin project create [flags]
Flags:
--description string A line about it
-h, --help[=true|false] help for create
--image string The image a workspace of it starts from (default: the installation's)
--name string What the project is called
--network-tag strings A network policy a workspace of it runs under, by name (repeatable)
--prebuild-keep int32 How many of each ref's newest prebuilds are kept when no workspace was opened from them (default: 1)
--prebuild-rebase-every int32 Every how many builds of a ref one is built from the image again (default: 10)
--prebuild-ref stringArray A ref it prebuilds: built as it moves, and what opening the project at it is cloned from (repeatable; the builds run as you)
--preset string The preset a workspace of it is sized by (default: the installation's)
--ref string The branch or tag a workspace opens at unless the open names one
--repository string The repository's https URL, with no credential in it
--slug string What it is named by in the installation (made from the name if empty)
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
Delete a project; one with a workspace open on it is refused
Usage:
spin project delete <slug> [flags]
Flags:
-h, --help[=true|false] help for delete
-y, --yes[=true|false] Skip confirmation
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
List the projects you see
Usage:
spin project list [flags]
Flags:
-h, --help[=true|false] help for list
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
Build one of a project's prebuild refs now, at the commit its forge says it is at, rather than at
the next look (every five minutes): a commit whose build failed is built again. The project's
admins only. Answered with the build, or the one of that commit already building or ready.
Usage:
spin project prebuild <slug> <ref> [flags]
Flags:
-h, --help[=true|false] help for prebuild
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
List a project's prebuilds: each build of one of its prebuild refs at a commit, what became of it,
and the snapshot opening the project at that ref is cloned from once it is ready.
Usage:
spin project prebuilds <slug> [flags]
Flags:
-h, --help[=true|false] help for prebuilds
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
Say who sees a project and who administers it: everybody (--everyone), or the people (--user,
by id) and teams (--team, by id, path or me) named; and its admins (--admin, by id), at least one,
who always see it. What is not named is no longer shared. Its admins only.
Example:
spin project share qboot --team /engineering --admin 0190c1f2-0000-7000-8000-000000000001
Usage:
spin project share <slug> [flags]
Flags:
--admin stringArray A person who administers it, by id (repeatable; at least one)
--everyone[=true|false] Everybody signed in sees it
-h, --help[=true|false] help for share
--team stringArray A team whose members see it, by id, path or me (repeatable)
--user stringArray A person who sees it, by id (repeatable)
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
Save a project whole: what each flag says is what the project becomes, and a flag not given
is the field emptied, since a project is saved as a form shows it. Its admins only. A workspace
already open keeps what it was opened with.
Usage:
spin project update <slug> [flags]
Flags:
--description string A line about it
-h, --help[=true|false] help for update
--image string The image a workspace of it starts from (default: the installation's)
--name string What the project is called
--network-tag strings A network policy a workspace of it runs under, by name (repeatable)
--prebuild-keep int32 How many of each ref's newest prebuilds are kept when no workspace was opened from them (default: 1)
--prebuild-rebase-every int32 Every how many builds of a ref one is built from the image again (default: 10)
--prebuild-ref stringArray A ref it prebuilds: built as it moves, and what opening the project at it is cloned from (repeatable; the builds run as you)
--preset string The preset a workspace of it is sized by (default: the installation's)
--ref string The branch or tag a workspace opens at unless the open names one
--repository string The repository's https URL, with no credential in it
--slug string What it is named by in the installation (made from the name if empty)
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.