
Company News
AWS Security Hub Adds Socket for Supply Chain Security
Socket is now in the AWS Security Hub Extended plan. Adopt it through AWS, apply committed spend, and block malicious open source packages.
spacefastThe Spacefast CLI publishes static sites, build outputs, docs, reports, and space previews from your terminal or automation. It is the fastest way to get a live Spacefast URL from a local folder.
curl -fsSL https://spacefast.com/install.sh | bash
sf publish ./dist
The first publish creates a live anonymous space and writes
.stattic/state.json inside the published directory (and records the space in
sf.jsonc when one exists). Publish the same directory again to update
the same space. sf publish waits until the version is live, then prints
a version receipt with the live and Version URLs.
Use the CLI interactively from a terminal, or pass --json on any command for
agent and CI workflows.
sf doctor
sf publish ./dist
To publish into your account or team:
sf login
sf teams switch my-team
sf publish ./dist
For CI, create an API key in Spacefast (or with sf api-keys create) and set
SPACEFAST_TOKEN, or pass --token directly:
SPACEFAST_TOKEN=... sf publish ./dist --json
When publishing a directory, the CLI uploads root _redirects and _headers
files and validates them before finalizing the version. _redirects supports
redirects, rewrites, custom 404 rules, and proxy rules. _headers supports
validated response headers and Basic-Auth.
Proxy rules use absolute external 200 destinations in _redirects:
/api/* https://api.example.com/:splat 200
Internal 200 destinations are rewrites.
$ sf autocomplete bash # or zsh / fish / powershell
$ sf autocomplete --refresh-cache
Follow the printed instructions to add the completion script to your shell init file.
$ sf --cwd ./apps/docs deploy
$ sf --cwd=/tmp/site env ls
Pass --cwd <path> to any command to operate as if it ran from that directory.
Useful in monorepos, CI scripts, or when the project state lives elsewhere.
$ npm install -g spacefast
$ sf COMMAND
running command...
$ sf (--version)
spacefast/0.0.1 darwin-arm64 node-v25.9.0
$ sf --help [COMMAND]
USAGE
$ sf COMMAND
...
sf accesssf access ban GRANTsf access clearsf access effectivesf access grant GRANTsf access lssf access rm IDsf access set FILEsf access showsf activitysf analyticssf annotationssf annotations exportsf annotations get ANNOTATIONsf annotations listsf annotations reopen ANNOTATIONsf annotations reply ANNOTATIONsf annotations resolve ANNOTATIONsf api METHODORPATH [PATH]sf api-keyssf api-keys createsf api-keys delete IDsf api-keys listsf api-keys revoke IDsf api-keys rm IDsf autocomplete [SHELL]sf build [DIR]sf builds cancel BUILDsf builds get BUILDsf builds logs BUILDsf builds lssf builds resume-upload BUILDsf builds retry BUILDsf channelssf channels history [NAME]sf channels lssf create NAMEsf deploy [DIR]sf deploymentssf deployments get DEPLOYMENTsf deployments lssf deployments promote DEPLOYMENTsf deployments rollback DEPLOYMENTsf doctorsf domainssf domains add HOSTNAMEsf domains check DOMAINsf domains diagnostics DOMAINsf domains dnssf domains dns add DOMAINsf domains dns batch DOMAINsf domains dns capabilities DOMAINsf domains dns export DOMAINsf domains dns ls DOMAINsf domains dns refresh DOMAINsf domains dns rm DOMAIN RECORDsf domains dns update DOMAIN RECORDsf domains lssf domains nameservers DOMAINsf domains nameservers set DOMAIN NAMESERVERSsf domains rm DOMAINsf domains search [QUERY]sf envsf env export-template [DIR]sf env import FILEsf env lssf env pullsf env rm NAMEsf env set NAME VALUEsf git buildsf git connectsf git disconnectsf git lssf git originsf git syncsf git updatesf help [COMMAND]sf initsf inspect [TARGET]sf linksf loginsf logoutsf logs [TARGET] [KIND]sf mcpsf open [TARGET]sf operations [ID]sf password clearsf password setsf profilessf profiles rm NAMEsf profiles set NAMEsf profiles use NAMEsf promote [VERSION]sf publish [DIR]sf rollback [VERSION]sf routingsf routing computesf routing inspectsf runtimesf runtime statussf sitessf sites createsf sites getsf sites lssf sites rmsf spacessf spaces addsf spaces claimsf spaces downloadsf spaces duplicatesf spaces exportsf spaces getsf spaces import [ARCHIVE]sf spaces lssf spaces rmsf spaces transfer TEAMsf spaces updatesf statussf switch [TEAM]sf syncsf teamssf teams invitationssf teams invitations add EMAILsf teams invitations cancel INVITATIONsf teams invitations lssf teams invitations resend INVITATIONsf teams lssf teams memberssf teams members lssf teams members rm MEMBERsf teams switch [TEAM]sf transfers cancel IDsf transfers confirm IDsf transfers get IDsf versionssf versions downloadsf versions get [VERSION]sf versions lssf versions rm [VERSION]sf whoamisf zerosf zero auth [ACTION] [SOURCE]sf zero build [SOURCE]sf zero create NAMEsf zero db [TARGET]sf zero db dump [TARGET]sf zero db list [TARGET]sf zero db migrate [SOURCE]sf zero deploy [SOURCE]sf zero dev [SOURCE]sf zero inspect [TARGET]sf zero logs [TARGET]sf zero new NAMEsf zero run-many [SOURCE]sf zero tokensf zero token createsf zero token listsf zero token lssf zero token revoke IDsf zero token rm IDsf accessManage access policy.
USAGE
$ sf access [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Manage access policy.
Read and edit a space's access/firewall policy: list the merged effective rules, grant or ban identity classes, and
remove cloud rules.
sf access ban GRANTBan an identity class space-wide.
USAGE
$ sf access ban GRANT [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>]
ARGUMENTS
GRANT Grant glob to ban, e.g. email:*@acme.com, team:eng:member, user:h.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Ban an identity class space-wide.
Prepend a cloud deny rule that blocks an identity class space-wide; it wins first-match-wins over any later allow.
EXAMPLES
Block a specific platform person.
$ sf access ban user:h
Block an entire email domain.
$ sf access ban email:*@spam.example
sf access clearClear cloud access policy.
USAGE
$ sf access clear [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>]
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Clear cloud access policy.
Drop the space's cloud access/firewall lane. The effective policy then falls back to file rules only.
sf access effectiveShow effective access policy.
USAGE
$ sf access effective [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>]
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Show effective access policy.
Show the resolved effective access policy: file rules then cloud rules, each annotated with its source and order.
sf access grant GRANTGrant access to an identity class.
USAGE
$ sf access grant GRANT [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>]
ARGUMENTS
GRANT Grant glob to admit, e.g. email:*@acme.com, team:eng:member, user:h.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Grant access to an identity class.
Append a cloud allow rule that admits any visitor whose verified grants intersect the glob (token.requiredGrants).
EXAMPLES
Allow any verified acme.com email.
$ sf access grant email:*@acme.com
Allow members of the eng team.
$ sf access grant team:eng:member
sf access lsList effective access rules.
USAGE
$ sf access ls [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>]
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List effective access rules.
List the merged effective access rules (file rules then cloud rules), each annotated with its source and order.
sf access rm IDRemove a cloud access rule.
USAGE
$ sf access rm ID [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>]
ARGUMENTS
ID Cloud-lane rule index to remove (the [N] shown by `sf access show`).
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Remove a cloud access rule.
Remove a single cloud access rule by its cloud-lane index. File rules (from sf.jsonc) cannot be removed here.
EXAMPLES
Remove the first cloud rule.
$ sf access rm 0
sf access set FILEReplace cloud access policy.
USAGE
$ sf access set FILE [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--expected-version <value>]
ARGUMENTS
FILE Path to a JSON policy document ({ rules: [...] }) of unified access rules.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
CONCURRENCY FLAGS
--expected-version=<value> Reject the write unless the stored lane version matches (lost-update protection).
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Replace cloud access policy.
Replace the space's cloud access/firewall rules from a JSON policy document. Bumps the lane version.
EXAMPLES
Replace cloud rules.
$ sf access set ./access.json
sf access showShow cloud access policy.
USAGE
$ sf access show [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>]
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Show cloud access policy.
Show the space's cloud access/firewall policy lane (rules and lane version).
sf activityShow activity events.
USAGE
$ sf activity [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--all] [--code <value>] [--since <value>] [--until <value>] [--limit
<value>] [--cursor <value>]
FLAGS
--all Read account-wide activity instead of a single space.
--code=<value> Filter by activity taxonomy code, for example version.promoted.
--cursor=<value> Pagination cursor from a previous response.
--limit=<value> Maximum number of events to return (default 50, max 100).
--since=<value> Only events at or after this ISO timestamp.
--until=<value> Only events before this ISO timestamp.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Show activity events.
Read the activity feed for the selected space, or pass --all for every event visible to your account.
EXAMPLES
$ sf activity
$ sf activity --code version.promoted
$ sf activity --all --since 2026-06-01T00:00:00Z
sf analyticsPrint runtime analytics.
USAGE
$ sf analytics [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--window 48h|7d|30d]
FLAGS
--window=<option> [default: 7d] Analytics window.
<options: 48h|7d|30d>
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Print runtime analytics.
Print runtime analytics series.
sf annotationsManage annotations.
USAGE
$ sf annotations
DESCRIPTION
Manage annotations.
List, export, and update version annotations.
sf annotations exportExport annotations.
USAGE
$ sf annotations export --version <value> [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>] [--format markdown|json] [--status open|resolved|archived]
FLAGS
--format=<option> [default: markdown] Export format.
<options: markdown|json>
--status=<option> Filter by status.
<options: open|resolved|archived>
--version=<value> (required) Version ID, ref, or number.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Export annotations.
Export annotation review context for agents and scripts.
sf annotations get ANNOTATIONShow an annotation.
USAGE
$ sf annotations get ANNOTATION [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>]
ARGUMENTS
ANNOTATION Annotation id, for example ann_123.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Show an annotation.
Show one annotation thread.
sf annotations listList annotations.
USAGE
$ sf annotations list --version <value> [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>] [--status open|resolved|archived] [--path <value>] [--limit
<value>]
FLAGS
--limit=<value> Maximum annotations to return.
--path=<value> Filter by page path.
--status=<option> Filter by status.
<options: open|resolved|archived>
--version=<value> (required) Version ID, ref, or number.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List annotations.
List annotations for one immutable version.
sf annotations reopen ANNOTATIONReopen an annotation.
USAGE
$ sf annotations reopen ANNOTATION [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>]
ARGUMENTS
ANNOTATION Annotation id, for example ann_123.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Reopen an annotation.
Reopen a resolved annotation thread.
sf annotations reply ANNOTATIONReply to an annotation.
USAGE
$ sf annotations reply ANNOTATION --body <value> [--json] [--api-url <value>] [--profile <value>] [--token <value>]
[-y] [--claim-token <value>] [-o <value>] [--space <value>]
ARGUMENTS
ANNOTATION Annotation id, for example ann_123.
FLAGS
--body=<value> (required) Reply body.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Reply to an annotation.
Reply to an annotation thread.
sf annotations resolve ANNOTATIONResolve an annotation.
USAGE
$ sf annotations resolve ANNOTATION [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>]
ARGUMENTS
ANNOTATION Annotation id, for example ann_123.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Resolve an annotation.
Resolve an annotation thread.
sf api METHODORPATH [PATH]Call the Spacefast API directly.
USAGE
$ sf api METHODORPATH [PATH] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-i <value>]
ARGUMENTS
METHODORPATH HTTP method (GET, POST, PATCH, PUT, DELETE) or request path.
[PATH] Request path, for example /v1/spaces/{spaceId}/versions.
FLAGS
-i, --input=<value> JSON request body: a literal string, @file, or - for stdin.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Call the Spacefast API directly.
Send a signed request to any API endpoint using the resolved profile credentials and print the raw response envelope.
The escape hatch for endpoints without command sugar.
EXAMPLES
$ sf api /v1/me
$ sf api GET /v1/spaces/spc_123/versions
$ sf api POST /v1/spaces/spc_123/exports --input '{"includeFiles":true}'
$ sf api PATCH /v1/spaces/spc_123 --input @space-patch.json
sf api-keysManage API keys.
USAGE
$ sf api-keys [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Manage API keys.
Manage platform API keys.
sf api-keys createCreate an API key.
USAGE
$ sf api-keys create [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-n <value>] [--preset
ci_deploy|space_publisher|space_admin|site_admin|domain_manager|team_admin|billing_viewer]
FLAGS
-n, --name=<value> Human-readable API key name.
--preset=<option> Access preset for the new API key.
<options:
ci_deploy|space_publisher|space_admin|site_admin|domain_manager|team_admin|billing_viewer>
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Create an API key.
Create a platform API key and print its one-time secret.
sf api-keys delete IDRevoke an API key.
USAGE
$ sf api-keys delete ID [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
ARGUMENTS
ID API key id.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Revoke an API key.
Revoke a platform API key.
sf api-keys listList API keys.
USAGE
$ sf api-keys list [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--limit <value>]
FLAGS
--limit=<value> Maximum number of API keys to return (default 50, max 100).
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
List API keys.
List platform API keys for the selected team.
sf api-keys revoke IDRevoke an API key.
USAGE
$ sf api-keys revoke ID [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
ARGUMENTS
ID API key id.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Revoke an API key.
Revoke a platform API key.
sf api-keys rm IDRevoke an API key.
USAGE
$ sf api-keys rm ID [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
ARGUMENTS
ID API key id.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Revoke an API key.
Revoke a platform API key.
sf autocomplete [SHELL]Display autocomplete installation instructions.
USAGE
$ sf autocomplete [SHELL] [-r]
ARGUMENTS
[SHELL] (zsh|bash|powershell) Shell type
FLAGS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
DESCRIPTION
Display autocomplete installation instructions.
EXAMPLES
$ sf autocomplete
$ sf autocomplete bash
$ sf autocomplete zsh
$ sf autocomplete powershell
$ sf autocomplete --refresh-cache
See code: @oclif/plugin-autocomplete
sf build [DIR]Build and pack static output.
USAGE
$ sf build [DIR] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--root-directory <value>] [--install-directory <value>] [--install-command <value>] [--build-command <value>]
[--output-directory <value>] [--env-file <value>...] [--ignored-build-command <value>] [--skip-install]
[--skip-build] [--prebuilt] [-o <value>] [--dry-run]
ARGUMENTS
[DIR] Project directory to build. Defaults to the current directory.
EXECUTION FLAGS
-o, --output=<value> [default: .stattic/build-output.tgz] Archive path to write.
--dry-run Print the detected build plan without installing, building, or packing.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
BUILD FLAGS
--build-command=<value> Build command. Defaults to framework and package script detection.
--env-file=<value>... Local dotenv file to load for install/build commands. Repeat for multiple files.
--ignored-build-command=<value> Command that exits 0 when this build should be skipped.
--install-command=<value> Install command. Defaults to package-manager detection.
--install-directory=<value> Project subdirectory to run dependency installation from.
--output-directory=<value> Build output directory relative to the app root.
--prebuilt Pack an already-built output directory; skips install and build.
--root-directory=<value> Project subdirectory that contains the app.
--skip-build Skip the build command and pack the selected directory unless --output-directory is
set.
--skip-install Skip the install command.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Build and pack static output.
Detect build settings, run the build, and pack the static output.
sf builds cancel BUILDCancel a build.
USAGE
$ sf builds cancel BUILD [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
ARGUMENTS
BUILD Build ID (bld_...).
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Cancel a build.
Cancel a build. Idempotent: terminal builds are returned unchanged in their terminal state.
sf builds get BUILDShow a build.
USAGE
$ sf builds get BUILD [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
ARGUMENTS
BUILD Build ID (bld_...).
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Show a build.
Fetch a build by id.
sf builds logs BUILDPrint build logs.
USAGE
$ sf builds logs BUILD [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--limit
<value>] [--cursor <value>] [-f]
ARGUMENTS
BUILD Build ID (bld_...).
FLAGS
-f, --follow Follow live build logs until the build reaches a terminal state.
--cursor=<value> Pagination cursor from a previous response.
--limit=<value> Maximum number of log lines.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Print build logs.
Print build runner log lines, newest first.
sf builds lsList builds.
USAGE
$ sf builds ls [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--limit <value>] [--cursor <value>]
FLAGS
--cursor=<value> Pagination cursor from a previous response.
--limit=<value> Maximum number of builds to return (default 20, max 100).
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List builds.
List a space's builds, newest first.
sf builds resume-upload BUILDRefresh source archive upload.
USAGE
$ sf builds resume-upload BUILD [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
ARGUMENTS
BUILD Build ID (bld_...) waiting for source archive upload.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Refresh source archive upload.
Refresh the source archive upload instruction for a build that is waiting for source archive upload.
sf builds retry BUILDRetry a terminal build.
USAGE
$ sf builds retry BUILD [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
ARGUMENTS
BUILD Build ID (bld_...) to retry.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Retry a terminal build.
Retry a terminal build with the same input, settings, and target.
sf channelsManage channels.
USAGE
$ sf channels [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Manage channels.
List channels and inspect their promotion history.
sf channels history [NAME]Show channel history.
USAGE
$ sf channels history [NAME] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>]
ARGUMENTS
[NAME] Channel name. Defaults to `live`.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Show channel history.
Show a channel's promotion history (the deploy log), newest first.
sf channels lsList channels.
USAGE
$ sf channels ls [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>]
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List channels.
List channels for a space and where each one points.
sf create NAMECreate a Spacefast project directory.
USAGE
$ sf create NAME [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--runtime
static|zero] [--template todo|guestbook] [--title <value>] [--no-git]
ARGUMENTS
NAME Directory name for the new project.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
ZERO FLAGS
--no-git Skip initializing git for a Zero starter app.
--template=<option> Zero starter template to scaffold.
<options: todo|guestbook>
--title=<value> Zero starter app title.
PROJECT FLAGS
--runtime=<option> [default: static] Project runtime to create.
<options: static|zero>
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Create a Spacefast project directory.
Create a new Spacefast project directory. Use --runtime zero to scaffold a Zero capsule.
EXAMPLES
Create a static Spacefast project directory.
$ sf create my-site
Create a Zero capsule directory.
$ sf create my-app --runtime zero --template guestbook
sf deploy [DIR]Build and deploy to Spacefast.
USAGE
$ sf deploy [DIR] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [-n <value>] [--slug <value>] [--hostname-scope team|global] [--spa
auto|true|false] [-m <value>] [--git-branch <value>] [--git-commit <value>] [--git-ref <value>] [--git-repository
<value>] [--source-type direct-upload|git] [--dry-run] [--remote] [--wait] [--wait-timeout <value>]
[--root-directory <value>] [--install-directory <value>] [--ref <value>] [--install-command <value>]
[--build-command <value>] [--output-directory <value>] [--env-file <value>...] [--ignored-build-command <value>]
[--source-include <value>...] [--skip-install] [--skip-build] [--prebuilt] [--allow-unsupported-platform-features]
[--auto-finalize]
ARGUMENTS
[DIR] Project directory to build and deploy. Defaults to the current directory.
VERSION SOURCE FLAGS
-m, --message=<value> [env: SPACEFAST_PUBLISH_MESSAGE] Plain-language changelog entry for this version, shown
in version history. Overrides the detected git commit message.
--git-branch=<value> [env: SPACEFAST_GIT_BRANCH] Git branch name to record on the version.
--git-commit=<value> [env: SPACEFAST_GIT_COMMIT] Git commit SHA to record on the version.
--git-ref=<value> [env: SPACEFAST_GIT_REF] Git ref to record on the version.
--git-repository=<value> [env: SPACEFAST_GIT_REPOSITORY] Git repository to record on the version, for example
owner/repo.
--source-type=<option> [env: SPACEFAST_SOURCE_TYPE] Version source type to record.
<options: direct-upload|git>
SPACE METADATA FLAGS
-n, --name=<value> Set the space title.
--hostname-scope=<option> Managed hostname scope for newly created spaces.
<options: team|global>
--slug=<value> Set the space slug when creating a new space.
--spa=<option> [default: auto] Control single-page app fallback detection.
<options: auto|true|false>
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
MIGRATION FLAGS
--allow-unsupported-platform-features Deploy even when imported platform config includes features Spacefast cannot
convert.
EXECUTION FLAGS
--[no-]auto-finalize Finalize the remote build automatically after staging the build output.
--dry-run Print the detected build plan without installing, building, or publishing.
--remote Upload the current source directory and run the build remotely.
--[no-]wait Wait until queued publish work finishes before returning.
--wait-timeout=<value> [default: 900] Seconds to wait for the version to become ready.
BUILD FLAGS
--build-command=<value> Build command. Defaults to framework and package script detection.
--env-file=<value>... Local dotenv file to load for install/build commands. Repeat for multiple files.
--ignored-build-command=<value> For --remote, command that skips the remote build when it exits 0.
--install-command=<value> Install command. Defaults to package-manager detection.
--install-directory=<value> Project subdirectory to run dependency installation from.
--output-directory=<value> Build output directory relative to the app root.
--prebuilt Publish an already-built output directory; skips install and build.
--ref=<value> [env: SPACEFAST_BUILD_REF] Source ref label to record with this deploy;
repository-triggered builds record their own ref.
--root-directory=<value> Project subdirectory that contains the app.
--skip-build Skip the build command and publish the selected directory unless --output-directory
is set.
--skip-install Skip the install command.
--source-include=<value>... Ignored file or directory to include in a remote source archive. Repeat for multiple
paths.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Build and deploy to Spacefast.
Detect build settings, run the build, and publish the output directory to Spacefast.
EXAMPLES
Build the current project and publish it.
$ sf deploy
Build a monorepo app and publish its output.
$ sf deploy --root-directory apps/web --output-directory dist
Upload source and run the build remotely.
$ sf deploy --remote
Publish an already-built output directory.
$ sf deploy --prebuilt dist
sf deploymentsManage deployments.
USAGE
$ sf deployments [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Manage deployments.
List and inspect deployment activity.
sf deployments get DEPLOYMENTShow a deployment.
USAGE
$ sf deployments get DEPLOYMENT [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>]
ARGUMENTS
DEPLOYMENT Deployment ID, usually dep_build_... or dep_version_....
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Show a deployment.
Fetch a deployment by id.
sf deployments lsList deployments.
USAGE
$ sf deployments ls [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--limit <value>] [--cursor <value>]
FLAGS
--cursor=<value> Pagination cursor from a previous response.
--limit=<value> Maximum number of deployments to return.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List deployments.
List deployments for a space, newest first.
sf deployments promote DEPLOYMENTPromote a deployment.
USAGE
$ sf deployments promote DEPLOYMENT [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>] [--channel <value>] [--wait] [--wait-timeout <value>]
ARGUMENTS
DEPLOYMENT Deployment ID to make live, usually dep_build_... or dep_version_....
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
EXECUTION FLAGS
--channel=<value> [default: live] Channel to point at this version (default "live").
--[no-]wait Wait until queued publish work finishes before returning.
--wait-timeout=<value> [default: 900] Seconds to wait for the version to become live.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Promote a deployment.
Promote the version produced by a deployment to a channel (default live).
sf deployments rollback DEPLOYMENTRoll back to a deployment.
USAGE
$ sf deployments rollback DEPLOYMENT [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>] [--channel <value>] [--wait] [--wait-timeout <value>]
ARGUMENTS
DEPLOYMENT Deployment ID to roll back to, usually dep_build_... or dep_version_....
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
EXECUTION FLAGS
--channel=<value> [default: live] Channel to point at this version (default "live").
--[no-]wait Wait until queued publish work finishes before returning.
--wait-timeout=<value> [default: 900] Seconds to wait for the version to become live.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Roll back to a deployment.
Roll live traffic back to the version produced by a deployment.
sf doctorDiagnose Spacefast CLI setup.
USAGE
$ sf doctor [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>]
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Diagnose Spacefast CLI setup.
Check local CLI state, auth, API reachability, and space selection for the current directory.
sf domainsManage domains.
USAGE
$ sf domains [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Manage domains.
Manage space domains.
sf domains add HOSTNAMEAttach a domain.
USAGE
$ sf domains add HOSTNAME [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>] [--wait] [--wait-timeout <value>] [--redirect-to <value>
--role standard|redirect] [--redirect-status 301|302|307|308 ]
ARGUMENTS
HOSTNAME Hostname to attach.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DOMAIN BEHAVIOR FLAGS
--redirect-status=<option> HTTP status for redirect domains.
<options: 301|302|307|308>
--redirect-to=<value> Destination for redirect domains.
--role=<option> How the domain should behave.
<options: standard|redirect>
EXECUTION FLAGS
--[no-]wait Wait until queued work finishes before returning.
--wait-timeout=<value> Seconds to wait for queued work to finish before giving up.
DESCRIPTION
Attach a domain.
Create a domain in the space team, attach it to the space, and queue a DNS check.
sf domains check DOMAINCheck a domain.
USAGE
$ sf domains check DOMAIN [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--wait] [--wait-timeout <value>]
ARGUMENTS
DOMAIN Domain ID or hostname.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
EXECUTION FLAGS
--[no-]wait Wait until queued work finishes before returning.
--wait-timeout=<value> Seconds to wait for queued work to finish before giving up.
DESCRIPTION
Check a domain.
Queue a DNS/provider readiness check for an attached domain.
sf domains diagnostics DOMAINInspect domain diagnostics.
USAGE
$ sf domains diagnostics DOMAIN [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>]
ARGUMENTS
DOMAIN Domain ID or hostname.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Inspect domain diagnostics.
Read live DNS and SSL diagnostics for an attached domain.
sf domains dnsManage domain DNS records.
USAGE
$ sf domains dns [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Manage domain DNS records.
Manage DNS records for a domain zone. See `domains dns ls`, `capabilities`, `refresh`, `add`, `update`, `rm`, `batch`,
and `export`.
sf domains dns add DOMAINAdd a DNS record.
USAGE
$ sf domains dns add DOMAIN [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--type
A|AAAA|ALIAS|CAA|CNAME|MX|NS|SRV|TXT] [--name <value>] [--value <value>] [--ttl <value>] [--priority <value>] [-o
<value>]
ARGUMENTS
DOMAIN Domain ID or hostname.
FLAGS
--name=<value> Record name relative to the zone, or @ for the apex.
--priority=<value> Priority for MX and SRV records.
--ttl=<value> Time to live in seconds (default 3600).
--type=<option> Record type.
<options: A|AAAA|ALIAS|CAA|CNAME|MX|NS|SRV|TXT>
--value=<value> Record value.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Add a DNS record.
Add a DNS record to the domain's Spacefast-managed zone.
EXAMPLES
$ sf domains dns add example.com --type MX --name @ --value mail.example.com --priority 10
sf domains dns batch DOMAINApply a DNS record batch.
USAGE
$ sf domains dns batch DOMAIN -i <value> [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-o
<value>]
ARGUMENTS
DOMAIN Domain ID or hostname.
FLAGS
-i, --input=<value> (required) JSON batch body: a literal string, @file, or - for stdin.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Apply a DNS record batch.
Apply a batch of DNS changes in one call. The JSON body holds delete/patch/put/post arrays of records.
EXAMPLES
$ sf domains dns batch example.com --input @dns-changes.json
$ sf domains dns batch example.com --input '{"posts":[{"type":"TXT","name":"@","value":"v=spf1 -all"}]}'
sf domains dns capabilities DOMAINShow DNS capabilities.
USAGE
$ sf domains dns capabilities DOMAIN [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-o
<value>]
ARGUMENTS
DOMAIN Domain ID or hostname.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Show DNS capabilities.
Show DNS provider capabilities for a domain.
sf domains dns export DOMAINExport the DNS zone.
USAGE
$ sf domains dns export DOMAIN [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-o <value>]
ARGUMENTS
DOMAIN Domain ID or hostname.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Export the DNS zone.
Print the domain's zone as BIND-style records.
sf domains dns ls DOMAINList DNS records.
USAGE
$ sf domains dns ls DOMAIN [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-o <value>]
[--limit <value>] [--cursor <value>]
ARGUMENTS
DOMAIN Domain ID or hostname.
FLAGS
--cursor=<value> Pagination cursor from a previous response.
--limit=<value> Maximum number of records to return (default 200, max 500).
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
List DNS records.
List DNS records in the domain's Spacefast-managed zone.
sf domains dns refresh DOMAINRefresh DNS provider snapshot.
USAGE
$ sf domains dns refresh DOMAIN [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-o <value>]
ARGUMENTS
DOMAIN Domain ID or hostname.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Refresh DNS provider snapshot.
Refresh a connected DNS provider snapshot for a domain.
sf domains dns rm DOMAIN RECORDDelete a DNS record.
USAGE
$ sf domains dns rm DOMAIN RECORD [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-o
<value>]
ARGUMENTS
DOMAIN Domain ID or hostname.
RECORD DNS record ID.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Delete a DNS record.
Delete a DNS record from the domain's zone.
sf domains dns update DOMAIN RECORDUpdate a DNS record.
USAGE
$ sf domains dns update DOMAIN RECORD [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--type
A|AAAA|ALIAS|CAA|CNAME|MX|NS|SRV|TXT] [--name <value>] [--value <value>] [--ttl <value>] [--priority <value>] [-o
<value>]
ARGUMENTS
DOMAIN Domain ID or hostname.
RECORD DNS record ID.
FLAGS
--name=<value> Record name relative to the zone, or @ for the apex.
--priority=<value> Priority for MX and SRV records.
--ttl=<value> Time to live in seconds (default 3600).
--type=<option> Record type.
<options: A|AAAA|ALIAS|CAA|CNAME|MX|NS|SRV|TXT>
--value=<value> Record value.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Update a DNS record.
Update fields on an existing DNS record.
sf domains lsList space domains.
USAGE
$ sf domains ls [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>]
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List space domains.
List domains attached to a space.
sf domains nameservers DOMAINShow domain nameservers.
USAGE
$ sf domains nameservers DOMAIN [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-o <value>]
ARGUMENTS
DOMAIN Domain ID or hostname.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Show domain nameservers.
Show the DNS mode and nameserver set for a domain.
sf domains nameservers set DOMAIN NAMESERVERSSet domain nameservers.
USAGE
$ sf domains nameservers set DOMAIN NAMESERVERS [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-o
<value>]
ARGUMENTS
DOMAIN Domain ID or hostname.
NAMESERVERS Comma-separated nameservers (at least two).
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Set domain nameservers.
Set custom nameservers for a Spacefast-registered domain. Externally registered domains change nameservers at their
registrar.
EXAMPLES
$ sf domains nameservers set example.com ns1.example-dns.com,ns2.example-dns.com
sf domains rm DOMAINRemove a domain.
USAGE
$ sf domains rm DOMAIN [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--wait]
ARGUMENTS
DOMAIN Domain ID or hostname.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
EXECUTION FLAGS
--[no-]wait Wait until queued publish work finishes before returning.
DESCRIPTION
Remove a domain.
Remove a domain assignment from a space.
sf domains search [QUERY]Search domain names.
USAGE
$ sf domains search [QUERY] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--interactive] [--limit <value>]
ARGUMENTS
[QUERY] Brand, idea, or full domain to search.
FLAGS
--interactive Open the interactive terminal domain search UI.
--limit=<value> [default: 20] Number of local suggestions to print when not interactive.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Search domain names.
Search domain ideas locally, with optional live availability checks in interactive mode.
sf envManage env vars.
USAGE
$ sf env [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Manage env vars.
Manage space environment variables.
sf env export-template [DIR]Create a dotenv import template from platform config.
USAGE
$ sf env export-template [DIR] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--format
env|json]
ARGUMENTS
[DIR] Project directory to inspect. Defaults to the current directory.
FLAGS
--format=<option> [default: env] Output format.
<options: env|json>
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Create a dotenv import template from platform config.
Read platform config files and print a dotenv template for variables to import into Spacefast.
sf env import FILEImport variables from a .env file.
USAGE
$ sf env import FILE [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--secret] [--production] [--preview] [--branch <value>...] [--from
dotenv|vercel|netlify|cloudflare]
ARGUMENTS
FILE .env file to import.
FLAGS
--branch=<value>... Also store each imported value for an exact branch. Repeat for multiple branches.
--from=<option> [default: dotenv] Platform export format to import. Vercel, Netlify, and Cloudflare use dotenv
exports.
<options: dotenv|vercel|netlify|cloudflare>
--preview Also store each imported value for preview builds.
--production Also store each imported value for production builds.
--secret Mark every imported value write-only.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Import variables from a .env file.
Import variables from a dotenv file. Values are sent to the API and are not printed back.
sf env lsList space variables.
USAGE
$ sf env ls [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--show-values]
FLAGS
--show-values Print plaintext variable values.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List space variables.
List space variables.
sf env pullPull variables.
USAGE
$ sf env pull [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--format env|json]
FLAGS
--format=<option> [default: env] Output format.
<options: env|json>
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Pull variables.
Pull effective space and shared variables.
sf env rm NAMEDelete a space variable.
USAGE
$ sf env rm NAME [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>]
ARGUMENTS
NAME Variable name.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Delete a space variable.
Delete a space variable.
sf env set NAME VALUESet a space variable.
USAGE
$ sf env set NAME VALUE [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>] [--secret] [--production-value <value>] [--preview-value
<value>] [--branch-value <value>...]
ARGUMENTS
NAME Variable name.
VALUE Variable value.
FLAGS
--secret Mark the value write-only: it is never returned by any later read.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
BUILD FLAGS
--branch-value=<value>... Value to inject for a branch build, formatted as branch=value. Repeat for multiple
branches.
--preview-value=<value> Value to inject for preview builds.
--production-value=<value> Value to inject for production builds.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Set a space variable.
Create or update a space variable. Values are sent to the API and are not printed back.
sf git buildBuild repository source.
USAGE
$ sf git build [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--connection-type connected|hosted] [--ref <value>] [--branch <value>]
[--commit <value>] [--pull-request <value>] [--target production|preview] [--root-directory <value>]
[--install-directory <value>] [--install-command <value>] [--build-command <value>] [--output-directory <value>]
[--ignored-build-command <value>] [--auto-finalize] [--allow-unsupported-platform-features] [--wait] [--wait-timeout
<value>]
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
MIGRATION FLAGS
--[no-]allow-unsupported-platform-features Allow unsupported Vercel or Cloudflare migration features for this build.
EXECUTION FLAGS
--[no-]auto-finalize Finalize the remote build automatically after staging the build output.
--[no-]wait Wait until queued publish work finishes before returning.
--wait-timeout=<value> [default: 900] Seconds to wait for the repository build to finish.
BUILD FLAGS
--branch=<value> [env: SPACEFAST_GIT_BRANCH] Branch name for preview alias and production branch
selection.
--build-command=<value> Override the saved build command for this build.
--commit=<value> [env: SPACEFAST_GIT_COMMIT] Commit SHA to build.
--ignored-build-command=<value> Override the saved ignored build command for this build.
--install-command=<value> Override the saved install command for this build.
--install-directory=<value> Override the saved dependency install directory for this build.
--output-directory=<value> Override the saved build output directory for this build.
--pull-request=<value> [env: SPACEFAST_PULL_REQUEST] Pull request number for preview builds.
--ref=<value> [env: SPACEFAST_BUILD_REF] Repository ref, branch, tag, or commit to build.
--root-directory=<value> Override the saved app root directory for this build.
--target=<option> Force production or preview build target.
<options: production|preview>
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
REPOSITORY FLAGS
--connection-type=<option> [default: connected] Repository connection type.
<options: connected|hosted>
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Build repository source.
Trigger a generic remote build from a repository connection.
sf git connectConnect repository.
USAGE
$ sf git connect [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--provider github|gitlab|bitbucket|generic] [--connection-type
connected|hosted] [--repository <value>] [--repository-id <value>] [--repository-name <value>] [--clone-url <value>]
[--upstream-url <value>] [--installation-id <value>] [--credential <value>] [--default-branch <value>]
[--production-branch <value>] [--ref <value>] [--auto-deploy-production] [--auto-deploy-previews] [--root-directory
<value>] [--install-directory <value>] [--install-command <value>] [--build-command <value>]
[--ignored-build-command <value>] [--output-directory <value>] [--framework-preset <value>] [--platform-preset
<value>] [--allow-unsupported-platform-features] [--apply-best] [--sync] [--build-now]
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
MIGRATION FLAGS
--allow-unsupported-platform-features Allow unsupported migration features.
AUTOMATION FLAGS
--apply-best Detect and save the highest-ranked build settings after connecting.
--[no-]auto-deploy-previews Automatically build preview branches and pull requests.
--[no-]auto-deploy-production Automatically build pushes to the production branch.
--build-now Queue a generic Build after connecting.
--sync Request repository sync after connecting.
BUILD FLAGS
--build-command=<value> Build command.
--framework-preset=<value> Framework preset.
--ignored-build-command=<value> Command that skips a build when it exits 0.
--install-command=<value> Install command.
--install-directory=<value> Dependency install directory.
--output-directory=<value> Build output directory.
--platform-preset=<value> Imported platform preset.
--root-directory=<value> App root directory.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
REPOSITORY FLAGS
--clone-url=<value> Clone URL when safe to expose.
--connection-type=<option> [default: connected] Repository connection type.
<options: connected|hosted>
--credential=<value> [env: SPACEFAST_REPOSITORY_CREDENTIAL] Generic Git clone token. Stored encrypted by the
API.
--default-branch=<value> Repository default branch.
--installation-id=<value> [env: SPACEFAST_REPOSITORY_INSTALLATION_ID] Repository app installation ID for external
statuses.
--production-branch=<value> Branch that publishes to production.
--provider=<option> Repository host.
<options: github|gitlab|bitbucket|generic>
--ref=<value> [env: SPACEFAST_BUILD_REF] Ref, branch, tag, or commit to sync or build after connecting.
--repository=<value> Repository full name, for example owner/repo. Defaults to the origin remote.
--repository-id=<value> Repository ID from the host.
--repository-name=<value> Repository name from the host.
--upstream-url=<value> Upstream repository URL.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Connect repository.
Create or replace a repository connection.
sf git disconnectDisconnect repository.
USAGE
$ sf git disconnect [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--connection-type connected|hosted]
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
REPOSITORY FLAGS
--connection-type=<option> [default: connected] Repository connection type.
<options: connected|hosted>
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Disconnect repository.
Delete a repository connection.
sf git lsShow repository connection.
USAGE
$ sf git ls [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--connection-type connected|hosted]
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
REPOSITORY FLAGS
--connection-type=<option> [default: connected] Repository connection type.
<options: connected|hosted>
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Show repository connection.
Show a repository connection.
sf git originInstall Spacefast git remote.
USAGE
$ sf git origin [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--set-origin]
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
GIT FLAGS
--set-origin Update origin instead of adding or updating the Spacefast remote.
DESCRIPTION
Install Spacefast git remote.
Install a signed Spacefast push remote for direct Git push deploys.
EXAMPLES
Add a signed `spacefast` remote when `origin` already points to your upstream.
$ sf git origin
Set `origin` to the signed Spacefast push remote.
$ sf git origin --set-origin
sf git syncSync remote repository source.
USAGE
$ sf git sync [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--ref <value>] [--ttl-seconds <value>] [--read-only-ref <value>...]
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
REPOSITORY FLAGS
--read-only-ref=<value>... Ref pattern to protect during repository sync. Repeat for multiple patterns.
--ref=<value> Ref, branch, or tag to sync.
--ttl-seconds=<value> Signed source remote TTL in seconds, up to 86400.
DESCRIPTION
Sync remote repository source.
Sync the upstream repository for this space.
sf git updateUpdate repository connection.
USAGE
$ sf git update [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--connection-type connected|hosted] [--clone-url <value>] [--upstream-url
<value>] [--production-branch <value>] [--credential <value>] [--clear-credential] [--auto-deploy-production]
[--auto-deploy-previews] [--root-directory <value>] [--install-directory <value>] [--install-command <value>]
[--build-command <value>] [--ignored-build-command <value>] [--output-directory <value>] [--framework-preset
<value>] [--platform-preset <value>] [--allow-unsupported-platform-features]
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
MIGRATION FLAGS
--[no-]allow-unsupported-platform-features Allow unsupported migration features.
AUTOMATION FLAGS
--[no-]auto-deploy-previews Automatically build preview branches and pull requests.
--[no-]auto-deploy-production Automatically build pushes to the production branch.
BUILD FLAGS
--build-command=<value> Build command.
--framework-preset=<value> Framework preset.
--ignored-build-command=<value> Command that skips a build when it exits 0.
--install-command=<value> Install command.
--install-directory=<value> Dependency install directory.
--output-directory=<value> Build output directory.
--platform-preset=<value> Imported platform preset.
--root-directory=<value> App root directory.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
REPOSITORY FLAGS
--clear-credential Clear the stored generic Git clone token.
--clone-url=<value> Clone URL when safe to expose.
--connection-type=<option> [default: connected] Repository connection type.
<options: connected|hosted>
--credential=<value> [env: SPACEFAST_REPOSITORY_CREDENTIAL] Generic Git clone token. Stored encrypted by the
API.
--production-branch=<value> Branch that publishes to production.
--upstream-url=<value> Upstream repository URL.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Update repository connection.
Update a repository connection.
sf help [COMMAND]Display help for sf.
USAGE
$ sf help [COMMAND...] [-n]
ARGUMENTS
[COMMAND...] Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for sf.
See code: @oclif/plugin-help
sf initCreate a Spacefast project.
USAGE
$ sf init [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [-f] [--runtime static|zero] [--template todo|guestbook] [--title <value>]
[--no-git]
EXECUTION FLAGS
-f, --force Overwrite existing generated files.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
ZERO FLAGS
--no-git Skip initializing git for a Zero starter app.
--template=<option> Zero starter template to scaffold.
<options: todo|guestbook>
--title=<value> Zero starter app title.
PROJECT FLAGS
--runtime=<option> [default: static] Project runtime to initialize.
<options: static|zero>
DESCRIPTION
Create a Spacefast project.
Create a Spacefast project in the current directory. Use --runtime zero to scaffold a Zero capsule instead of a static
config.
EXAMPLES
Write a starter sf.jsonc in the current directory.
$ sf init
Initialize config and link the current directory to space `docs`.
$ sf init --space docs
Scaffold a Zero capsule in the current directory.
$ sf init --runtime zero --template guestbook
sf inspect [TARGET]Inspect a space by ID, slug, URL, or domain.
USAGE
$ sf inspect [TARGET] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-o <value>]
ARGUMENTS
[TARGET] Space ID, slug, live URL, or domain.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Inspect a space by ID, slug, URL, or domain.
Look up a space by ID, slug, live URL, or attached domain. Prints space details, live version, and runtime state.
EXAMPLES
Inspect by slug.
$ sf inspect docs
Inspect by live URL.
$ sf inspect https://docs.spacefast.com
Inspect by ID in a specific team.
$ sf inspect prj_abc123 --team acme
sf linkLink the current directory to a space.
USAGE
$ sf link [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>]
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Link the current directory to a space.
Resolve an existing space by --space and save it to .stattic/state.json in the current directory. Use this to bind a
local directory to a remote space without publishing.
EXAMPLES
Link the current directory to a space by slug.
$ sf link --space my-space
Link the current directory to a space by id in a specific team.
$ sf link --space prj_abc123 --team acme
sf loginLog in to Spacefast.
USAGE
$ sf login [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-o <value>]
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Log in to Spacefast.
Authenticate this machine with browser device login, or save a provided access token.
EXAMPLES
Start browser-assisted device login.
$ sf login
Store a token for non-interactive use.
$ sf login --token st_...
sf logoutLog out of Spacefast.
USAGE
$ sf logout [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Log out of Spacefast.
Delete the local login and revoke the CLI-minted token when possible.
sf logs [TARGET] [KIND]Print runtime activity.
USAGE
$ sf logs [TARGET] [KIND] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>] [--limit <value>]
ARGUMENTS
[TARGET] Space ID, slug, live URL, or domain. Defaults to the linked space.
[KIND] Log kind: access or runtime. Defaults to access.
FLAGS
--limit=<value> [default: 50] Maximum number of log entries.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Print runtime activity.
Print runtime activity logs for a space. Pass a target to operate on any space without --space.
EXAMPLES
Tail logs for the linked space.
$ sf logs
Tail logs for space `docs`.
$ sf logs docs
Tail access logs for a space by URL.
$ sf logs https://docs.spacefast.com access
sf mcpRun the Spacefast MCP server.
USAGE
$ sf mcp [--transport stdio|http|streamable-http] [--host <value>] [--port <value>] [--path <value>]
[--api-url <value>] [--token <value>]
FLAGS
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL for MCP tool calls.
--host=<value> [default: 127.0.0.1, env: SPACEFAST_MCP_HOST] Host for streamable HTTP.
--path=<value> [default: /mcp, env: SPACEFAST_MCP_PATH] HTTP path for streamable HTTP.
--port=<value> [default: 3945, env: SPACEFAST_MCP_PORT] Port for streamable HTTP.
--token=<value> [env: SPACEFAST_TOKEN] Spacefast API token for MCP tool calls.
--transport=<option> MCP transport to run. `http` is streamable HTTP.
<options: stdio|http|streamable-http>
DESCRIPTION
Run the Spacefast MCP server.
Run the Spacefast MCP server from the CLI package. Defaults to stdio for MCP clients; use the HTTP transport for
embedded streamable HTTP.
EXAMPLES
$ sf mcp
$ sf mcp --transport http --port 3945
$ sf mcp http --host 0.0.0.0 --path /mcp
sf open [TARGET]Open a space in your browser.
USAGE
$ sf open [TARGET] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-o <value>]
ARGUMENTS
[TARGET] Space ID, slug, live URL, or domain. Defaults to the linked space.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Open a space in your browser.
Open a space's live URL in the default browser.
EXAMPLES
Open the linked space.
$ sf open
Open space `docs` by slug.
$ sf open docs
sf operations [ID]Inspect async operations.
USAGE
$ sf operations [ID] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--space <value>]
[--limit <value>] [--cursor <value>]
ARGUMENTS
[ID] Operation ID. Omit to list recent operations.
FLAGS
--cursor=<value> Pagination cursor from a previous response.
--limit=<value> Maximum number of operations to return (default 50, max 100).
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
SPACE SELECTION FLAGS
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Inspect async operations.
List recent async operations or read one by ID. Pass --space to scope the list to a space.
ALIASES
$ sf ops
EXAMPLES
$ sf ops
$ sf ops op_123
$ sf operations --space spc_123
sf password clearClear space password protection.
USAGE
$ sf password clear [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--wait]
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
EXECUTION FLAGS
--[no-]wait Wait until queued publish work finishes before returning.
DESCRIPTION
Clear space password protection.
Disable space password protection.
sf password setSet space password protection.
USAGE
$ sf password set [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--stdin] [--wait]
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
INPUT FLAGS
--stdin Read the password from stdin instead of prompting.
EXECUTION FLAGS
--[no-]wait Wait until queued publish work finishes before returning.
DESCRIPTION
Set space password protection.
Enable or replace space password protection.
sf profilesList provider profiles.
USAGE
$ sf profiles [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
List provider profiles.
List named provider profiles. A profile binds an API base URL and credential so the CLI can publish to any
Spacefast-compatible control plane.
sf profiles rm NAMERemove a provider profile.
USAGE
$ sf profiles rm NAME [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
ARGUMENTS
NAME Profile name.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Remove a provider profile.
Delete a named provider profile and its stored credential.
sf profiles set NAMECreate or update a provider profile.
USAGE
$ sf profiles set NAME [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
ARGUMENTS
NAME Profile name.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> Provider API base URL for this profile.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> Access token bound to this profile. Pass "" to clear a saved token.
DESCRIPTION
Create or update a provider profile.
Create or update a named provider profile. Pass --api-url for the provider endpoint and --token to bind a credential
to it. Pass --token "" to clear a saved token.
EXAMPLES
$ sf profiles set acme --api-url https://api.acme-host.example --token st_...
$ sf profiles set acme --token ""
sf profiles use NAMESelect the active provider profile.
USAGE
$ sf profiles use NAME [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
ARGUMENTS
NAME Profile name.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Select the active provider profile.
Select the profile used when no --profile flag or env is set.
sf promote [VERSION]Promote a version to a channel.
USAGE
$ sf promote [VERSION] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>] [--channel <value>] [--wait] [--wait-timeout <value>]
ARGUMENTS
[VERSION] Version ID, ref, or number to make live, for example ver_123, v12, or 12.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
EXECUTION FLAGS
--channel=<value> [default: live] Channel to point at this version (default "live").
--[no-]wait Wait until queued publish work finishes before returning.
--wait-timeout=<value> [default: 900] Seconds to wait for the version to become live.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Promote a version to a channel.
Promote an existing ready version to a channel (default live). Use `rollback` to roll back to an older version
instead.
EXAMPLES
Make version v12 live.
$ sf promote v12
Promote explicitly to the live channel.
$ sf promote v12 --channel live
Queue promotion and print the operation as JSON.
$ sf promote ver_123 --no-wait --json
sf publish [DIR]Publish files to Spacefast.
USAGE
$ sf publish [DIR] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [-n <value>] [--slug <value>] [--hostname-scope team|global] [--spa
auto|true|false] [-m <value>] [--git-branch <value>] [--git-commit <value>] [--git-ref <value>] [--git-repository
<value>] [--source-type direct-upload|git] [--dry-run] [--config-only] [--wait] [--wait-timeout <value>] [--build]
[--root-directory <value>] [--install-directory <value>] [--install-command <value>] [--build-command <value>]
[--output-directory <value>] [--env-file <value>...] [--skip-install] [--skip-build]
[--allow-unsupported-platform-features]
ARGUMENTS
[DIR] File or directory to publish. With --build, the project directory to build. Defaults to the current directory.
VERSION SOURCE FLAGS
-m, --message=<value> [env: SPACEFAST_PUBLISH_MESSAGE] Plain-language changelog entry for this version, shown
in version history. Overrides the detected git commit message.
--git-branch=<value> [env: SPACEFAST_GIT_BRANCH] Git branch name to record on the version.
--git-commit=<value> [env: SPACEFAST_GIT_COMMIT] Git commit SHA to record on the version.
--git-ref=<value> [env: SPACEFAST_GIT_REF] Git ref to record on the version.
--git-repository=<value> [env: SPACEFAST_GIT_REPOSITORY] Git repository to record on the version, for example
owner/repo.
--source-type=<option> [env: SPACEFAST_SOURCE_TYPE] Version source type to record.
<options: direct-upload|git>
SPACE METADATA FLAGS
-n, --name=<value> Set the space title.
--hostname-scope=<option> Managed hostname scope for newly created spaces.
<options: team|global>
--slug=<value> Set the space slug when creating a new space.
--spa=<option> [default: auto] Control single-page app fallback detection.
<options: auto|true|false>
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
BUILD FLAGS
--allow-unsupported-platform-features Build even when imported platform config includes features Spacefast cannot
convert.
--build Run the detected (or configured) install and build commands before publishing.
--build-command=<value> Build command. Defaults to framework and package script detection. Implies
--build.
--env-file=<value>... Local dotenv file to load for install/build commands. Repeat for multiple
files. Implies --build.
--install-command=<value> Install command. Defaults to package-manager detection. Implies --build.
--install-directory=<value> Repository subdirectory to run dependency installation from. Implies --build.
--output-directory=<value> Build output directory relative to the app root. Implies --build.
--root-directory=<value> Repository subdirectory that contains the app. Implies --build.
--skip-build Skip the build command and publish the selected directory unless
--output-directory is set. Implies --build.
--skip-install Skip the install command. Implies --build.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
EXECUTION FLAGS
--config-only Publish a fast config-only version that recompiles sf.jsonc and carries the prior artifact
forward without rebuilding or re-uploading content. Auto-detected when only sf.jsonc changed.
--dry-run Print the publish (or build) plan without uploading files or writing state.
--[no-]wait Wait until queued publish work finishes before returning.
--wait-timeout=<value> [default: 900] Seconds to wait for the version to become ready.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Publish files to Spacefast.
Publish a file or directory to a Spacefast space. Without --space, the CLI creates or reuses the space saved in
.stattic/state.json. With --build, detect build settings, run the build, and publish the output directory.
EXAMPLES
Publish a build directory.
$ sf publish ./dist
Publish with explicit SPA fallback and space title.
$ sf publish ./dist --spa true --name docs
Update an existing space and print machine-readable output.
$ sf publish ./dist --space pr-preview --json
Build a monorepo app and publish its output.
$ sf publish --build --root-directory apps/web --output-directory dist
sf rollback [VERSION]Roll back to a previous version.
USAGE
$ sf rollback [VERSION] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>] [--channel <value>] [--wait] [--wait-timeout <value>]
ARGUMENTS
[VERSION] Version ID, ref, or number to make live, for example ver_123, v12, or 12.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
EXECUTION FLAGS
--channel=<value> [default: live] Channel to point at this version (default "live").
--[no-]wait Wait until queued publish work finishes before returning.
--wait-timeout=<value> [default: 900] Seconds to wait for the version to become live.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Roll back to a previous version.
Roll live traffic back to an existing ready version. Use `versions ls` to find a version.
EXAMPLES
List versions and find the target rollback version.
$ sf versions ls
Make version v12 live.
$ sf rollback v12
Make version v12 live for a selected space.
$ sf rollback 12 --space docs
sf routingRouting utilities.
USAGE
$ sf routing [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Routing utilities.
Inspect routing configuration and compute redirects/headers.
sf routing computeCompute routing.
USAGE
$ sf routing compute [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>]
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Compute routing.
Resolve the latest deployment's _redirects and _headers with current variables.
sf routing inspectInspect local routing files.
USAGE
$ sf routing inspect [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-r <value>] [--url
<value>...]
FLAGS
-r, --routing=<value> [default: .] Directory containing _redirects and _headers to inspect.
--url=<value>... URL or path to match against local routing rules. Repeat for multiple URLs.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Inspect local routing files.
Compile local _redirects and _headers files and optionally match URLs against the compiled rules.
sf runtimeManage runtime.
USAGE
$ sf runtime [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Manage runtime.
Inspect runtime status for a space.
sf runtime statusPrint runtime status.
USAGE
$ sf runtime status [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>]
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Print runtime status.
Print runtime status for a space.
sf sitesManage sites.
USAGE
$ sf sites [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Manage sites.
Manage dedicated Spacefast runtime sites.
sf sites createCreate a site.
USAGE
$ sf sites create [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-n <value>]
[--hosting-kind <value>] [--isolation site|space] [--region <value>] [--import-provider-site-id <value>]
FLAGS
-n, --name=<value> Human-readable site name for operator/test logs.
--hosting-kind=<value> [default: static] Runtime kind to provision.
--import-provider-site-id=<value> Import an existing provider site id instead of provisioning a fresh one.
--isolation=<option> [default: site] Whether settings default at the site or space level.
<options: site|space>
--region=<value> Placement region. Defaults to auto.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Create a site.
Create a dedicated Spacefast runtime site.
sf sites getShow a site.
USAGE
$ sf sites get --site <value> [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
SITE SELECTION FLAGS
--site=<value> (required) [env: SPACEFAST_SITE] Site ID.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Show a site.
Fetch a site by id.
sf sites lsList sites.
USAGE
$ sf sites ls [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--limit <value>]
[--cursor <value>] [--hosting-kind <value>]
FLAGS
--cursor=<value> Pagination cursor from a previous response.
--hosting-kind=<value> Filter by runtime kind.
--limit=<value> Maximum number of sites to return (default 20, max 100).
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
List sites.
List dedicated sites accessible to the current login.
sf sites rmDelete a site.
USAGE
$ sf sites rm --site <value> [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
SITE SELECTION FLAGS
--site=<value> (required) [env: SPACEFAST_SITE] Site ID.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Delete a site.
Delete a dedicated site.
sf spacesManage spaces.
USAGE
$ sf spaces [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Manage spaces.
Manage Spacefast spaces.
sf spaces addCreate an empty space.
USAGE
$ sf spaces add [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-o <value>] [-n
<value>] [--slug <value>] [--hostname-scope team|global] [--spa auto|true|false] [--mode website|files]
[--save-state]
SPACE METADATA FLAGS
-n, --name=<value> Set the space title.
--hostname-scope=<option> Managed hostname scope for newly created spaces.
<options: team|global>
--mode=<option> Space serving mode.
<options: website|files>
--slug=<value> Set the space slug when creating a new space.
--spa=<option> [default: auto] Control single-page app fallback detection.
<options: auto|true|false>
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
EXECUTION FLAGS
--[no-]save-state Write the created space to .stattic/state.json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Create an empty space.
Create an empty space and save it to .stattic/state.json.
EXAMPLES
Create an empty space.
$ sf spaces add --name docs
sf spaces claimClaim an anonymous space.
USAGE
$ sf spaces claim [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--wait]
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
EXECUTION FLAGS
--[no-]wait Wait until queued publish work finishes before returning.
DESCRIPTION
Claim an anonymous space.
Move a saved anonymous space into your account. If needed, the CLI starts browser login first.
EXAMPLES
Claim the space saved in the current directory.
$ sf spaces claim
Claim a space into a specific team.
$ sf spaces claim --claim-token claim_xxx --team my-team
sf spaces downloadDownload a space version.
USAGE
$ sf spaces download [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--output <value>] [--overwrite] [-j <value>] [-v <value>]
FLAGS
-j, --concurrency=<value> [default: 10] Number of files to download at the same time.
-v, --version=<value> [default: latest] Version ID, version ref, number, or "latest".
--output=<value> [default: .] Directory to write downloaded files into.
--overwrite Overwrite files that already exist in the output directory.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Download a space version.
Download files from a space version. Defaults to the latest version.
sf spaces duplicateDuplicate a space with a download-and-publish copy.
USAGE
$ sf spaces duplicate [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--slug <value>] [--title <value>] [--version <value>] [--wait]
[--wait-timeout <value>]
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DUPLICATE TARGET FLAGS
--slug=<value> Slug for the duplicate space.
--title=<value> Title for the duplicate space.
DUPLICATE SOURCE FLAGS
--version=<value> Version to duplicate. Defaults to the live version.
EXECUTION FLAGS
--[no-]wait Wait until queued publish work finishes before returning.
--wait-timeout=<value> [default: 900] Seconds to wait for the duplicate to become ready.
DESCRIPTION
Duplicate a space with a download-and-publish copy.
Download an existing space version and publish those files as a new space.
sf spaces exportExport a space archive.
USAGE
$ sf spaces export [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--version <value>] [--output <value>] [--overwrite] [--wait]
[--wait-timeout <value>]
FLAGS
--output=<value> Download the ready archive to this path (implies --wait).
--overwrite Overwrite an existing archive file when --output is set.
--version=<value> Export a single version instead of the default set.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
EXECUTION FLAGS
--[no-]wait Wait until queued work finishes before returning.
--wait-timeout=<value> Seconds to wait for queued work to finish before giving up.
DESCRIPTION
Export a space archive.
Create a portable export archive of the selected space (files plus explicit config). With --wait it returns the
download link; add --output to download the zip.
EXAMPLES
$ sf spaces export --wait --output ./site-export.zip
$ sf spaces export --version ver_123 --wait
sf spaces getShow a space.
USAGE
$ sf spaces get [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>]
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Show a space.
Resolve a space from --space or .stattic/state.json and print its live runtime state, current version, and runtime
details.
sf spaces import [ARCHIVE]Import a space archive.
USAGE
$ sf spaces import [ARCHIVE] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>] [--from-export <value>] [--publish] [--wait] [--wait-timeout
<value>]
ARGUMENTS
[ARCHIVE] Path to a Spacefast export zip archive.
FLAGS
--from-export=<value> Import from an existing export ID instead of uploading an archive.
--publish Publish the imported version once it is ready.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
EXECUTION FLAGS
--[no-]wait Wait until queued publish work finishes before returning.
--wait-timeout=<value> Seconds to wait for queued work to finish before giving up.
DESCRIPTION
Import a space archive.
Import an export archive into the selected space as draft versions. Pass --publish to promote the imported version
when it is ready.
EXAMPLES
$ sf spaces import ./site-export.zip
$ sf spaces import --from-export exp_123 --publish
sf spaces lsList spaces.
USAGE
$ sf spaces ls [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-o <value>] [--limit
<value>]
FLAGS
--limit=<value> Maximum number of spaces to return (default 50, max 200).
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
List spaces.
List spaces accessible to the current login, optionally filtered by team.
sf spaces rmDelete a space.
USAGE
$ sf spaces rm [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--wait]
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
EXECUTION FLAGS
--[no-]wait Wait until queued publish work finishes before returning.
DESCRIPTION
Delete a space.
Queue deletion for the selected space.
sf spaces transfer TEAMTransfer a space to another team.
USAGE
$ sf spaces transfer TEAM [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>]
ARGUMENTS
TEAM Target team slug, ID, or name.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Transfer a space to another team.
Request a transfer of the selected space to another team. The transfer applies after a member of the target team
confirms it.
EXAMPLES
$ sf spaces transfer acme --space spc_123
sf spaces updatePatch space metadata.
USAGE
$ sf spaces update [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--wait] [--wait-timeout <value>] [--mode website|files] [--spa
auto|true|false] [-n <value>] [--viewer-description <value>] [--viewer-og-image-path <value>] [--viewer-title
<value>]
SITE METADATA FLAGS
-n, --name=<value> Space title.
--mode=<option> Serving mode.
<options: website|files>
--spa=<option> Enable or disable SPA fallback. `auto` leaves the current setting unchanged.
<options: auto|true|false>
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
VIEWER METADATA FLAGS
--viewer-description=<value> Social preview description. Pass null to clear.
--viewer-og-image-path=<value> Social preview image path. Pass null to clear.
--viewer-title=<value> Viewer page title. Pass null to clear.
EXECUTION FLAGS
--[no-]wait Wait until queued publish work finishes before returning.
--wait-timeout=<value> Seconds to wait for queued work to finish before giving up.
DESCRIPTION
Patch space metadata.
Patch space serving metadata and generated viewer metadata.
sf statusShow CLI status.
USAGE
$ sf status [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Show CLI status.
Show authenticated user, default team, and the space the current directory is linked to.
sf switch [TEAM]Switch teams.
USAGE
$ sf switch [TEAM] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-o <value>]
ARGUMENTS
[TEAM] Team slug, ID, or name.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Switch teams.
Set the default team for future CLI commands.
sf syncSync pending changes.
USAGE
$ sf sync [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--wait] [--wait-timeout <value>]
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
EXECUTION FLAGS
--[no-]wait Wait until queued publish work finishes before returning.
--wait-timeout=<value> [default: 900] Seconds to wait for sync work to finish.
DESCRIPTION
Sync pending changes.
Sync pending space changes into a version.
sf teamsManage teams.
USAGE
$ sf teams [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Manage teams.
Manage teams and members.
sf teams invitationsManage team invitations.
USAGE
$ sf teams invitations [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Manage team invitations.
Manage team invitations.
sf teams invitations add EMAILCreate a team invitation.
USAGE
$ sf teams invitations add EMAIL [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-o <value>]
[--role owner|admin|member]
ARGUMENTS
EMAIL Email address to invite.
FLAGS
--role=<option> [default: member] Role to grant when the invitation is accepted.
<options: owner|admin|member>
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Create a team invitation.
Invite a person to a team.
sf teams invitations cancel INVITATIONCancel a team invitation.
USAGE
$ sf teams invitations cancel INVITATION [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-o
<value>]
ARGUMENTS
INVITATION Invitation id.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Cancel a team invitation.
Cancel a team invitation.
sf teams invitations lsList team invitations.
USAGE
$ sf teams invitations ls [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-o <value>]
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
List team invitations.
List pending and historical team invitations.
sf teams invitations resend INVITATIONResend a team invitation.
USAGE
$ sf teams invitations resend INVITATION [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-o
<value>]
ARGUMENTS
INVITATION Invitation id.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Resend a team invitation.
Resend a pending team invitation.
sf teams lsList teams.
USAGE
$ sf teams ls [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
List teams.
List teams available to the current login.
sf teams membersManage team members.
USAGE
$ sf teams members [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Manage team members.
Manage team members.
sf teams members lsList team members.
USAGE
$ sf teams members ls [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-o <value>]
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
List team members.
List members in a team.
sf teams members rm MEMBERRemove a team member.
USAGE
$ sf teams members rm MEMBER [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-o <value>]
ARGUMENTS
MEMBER Member id or email.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Remove a team member.
Remove a member from a team.
sf teams switch [TEAM]Set default team.
USAGE
$ sf teams switch [TEAM] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-o <value>]
ARGUMENTS
[TEAM] Team slug, ID, or name.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Set default team.
Set the default team for future CLI publishes.
sf transfers cancel IDCancel a space transfer.
USAGE
$ sf transfers cancel ID [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
ARGUMENTS
ID Transfer ID.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Cancel a space transfer.
Cancel a pending space transfer.
sf transfers confirm IDConfirm a space transfer.
USAGE
$ sf transfers confirm ID [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
ARGUMENTS
ID Transfer ID.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Confirm a space transfer.
Confirm a pending space transfer as a member of the target team. The space then moves to the new team.
sf transfers get IDShow a space transfer.
USAGE
$ sf transfers get ID [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
ARGUMENTS
ID Transfer ID.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Show a space transfer.
Read a space transfer by ID.
sf versionsManage versions.
USAGE
$ sf versions [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Manage versions.
List, promote, and roll back space versions.
sf versions downloadDownload a version archive.
USAGE
$ sf versions download [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [-v <value>] [--output <value>] [--overwrite] [--wait] [--wait-timeout
<value>]
FLAGS
-v, --version=<value> [default: latest] Version ID, version ref, number, or "latest".
--output=<value> Archive file path, or an existing directory to write the archive into.
--overwrite Overwrite an existing archive file.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
EXECUTION FLAGS
--[no-]wait Wait until queued publish work finishes before returning.
--wait-timeout=<value> Seconds to wait for queued work to finish before giving up.
DESCRIPTION
Download a version archive.
Create a scoped export for one version and download the resulting archive.
sf versions get [VERSION]Show a version.
USAGE
$ sf versions get [VERSION] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>]
ARGUMENTS
[VERSION] Version ID, ref, or number, for example ver_123, v12, or 12.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Show a version.
Show one version's status, source, Version URL, diagnostics, and failure details.
EXAMPLES
Inspect version v12 of the linked space.
$ sf versions get v12
Print a version of a selected space as JSON.
$ sf versions get ver_123 --space docs --json
sf versions lsList space versions.
USAGE
$ sf versions ls [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>]
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List space versions.
List space versions and mark the live and currently deploying entries.
sf versions rm [VERSION]Delete a version.
USAGE
$ sf versions rm [VERSION] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>]
ARGUMENTS
[VERSION] Version ID, ref, or number, for example ver_123, v12, or 12.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Delete a version.
Delete a version and purge its files. Versions referenced by a channel (live) cannot be deleted; promote another
version first. The version URL starts serving a tombstone.
EXAMPLES
Delete version v12 of the linked space.
$ sf versions rm v12
Delete without a confirmation prompt.
$ sf versions rm ver_123 --space docs --yes
sf whoamiShow the current Spacefast account.
USAGE
$ sf whoami [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Show the current Spacefast account.
Verify the active token and print the authenticated account.
sf zeroManage Zero runtime apps.
USAGE
$ sf zero [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Manage Zero runtime apps.
Build and run Spacefast Zero capsules.
sf zero auth [ACTION] [SOURCE]Manage Zero auth.
USAGE
$ sf zero auth [ACTION] [SOURCE] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-o
<value>] [--user-id <value>] [--user <value>] [--email <value>] [--name <value>]
ARGUMENTS
[ACTION] (login|status|logout|as|reset|local-status) [default: status] Auth action.
[SOURCE] [default: .] Capsule source directory.
FLAGS
--email=<value> Local authenticated email.
--name=<value> Local authenticated display name.
--user=<value> Alias for --user-id.
--user-id=<value> Local authenticated user id for `zero auth as`.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Manage Zero auth.
Manage Spacefast auth for Zero deploys and local Zero dev auth identity.
EXAMPLES
$ sf zero auth login
$ sf zero auth status
$ sf zero auth logout
$ sf zero auth as --user-id usr_local --email user@example.test
$ sf zero auth local-status
$ sf zero auth reset
sf zero build [SOURCE]Build a Zero artifact manifest.
USAGE
$ sf zero build [SOURCE] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--out
<value>] [--finalize-out <value>] [--runner-sha256 <value>] [--previous-artifact <value>] [--central-realtime-url
<value>] [--auth-sign-in-url <value>] [--auth-sign-out-url <value>] [--public-inspect] [--drop | --rename]
ARGUMENTS
[SOURCE] [default: .] Capsule source directory.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
RUNTIME FLAGS
--auth-sign-in-url=<value> Central Spacefast auth URL that starts hosted Zero WP.com sign-in.
--auth-sign-out-url=<value> Central Spacefast auth URL that signs out hosted Zero users.
--central-realtime-url=<value> Central Spacefast realtime URL for production mutation events.
--drop Allow generated Zero migration plans to include explicit drop operations.
--previous-artifact=<value> Path to a previous Zero artifact or finalize payload for update migration planning.
--public-inspect Make hosted Zero inspect metadata public. Private is the default.
--rename Allow generated Zero migration plans to include explicit rename operations.
--runner-sha256=<value> Expected sha256 digest for the prebuilt Rust runner.
OUTPUT FLAGS
--finalize-out=<value> [default: .stattic/zero/finalize.json] Path to write the runtime finalize payload.
--out=<value> [default: .stattic/zero/artifact.json] Path to write the Zero artifact manifest.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Build a Zero artifact manifest.
Build a Spacefast Zero capsule artifact manifest.
EXAMPLES
$ sf zero build
$ sf zero build ./todo --out .stattic/zero/artifact.json
$ sf zero build ./todo --central-realtime-url https://realtime.spacefast.example
sf zero create NAMECreate a Zero app.
USAGE
$ sf zero create NAME [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--template
todo|guestbook] [--title <value>] [--no-git]
ARGUMENTS
NAME Directory name for the new capsule.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
TEMPLATE FLAGS
--no-git Do not initialize a git repository for the new capsule.
--template=<option> [default: todo] Starter template to create.
<options: todo|guestbook>
--title=<value> Display title for the starter app.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Create a Zero app.
Create a new Spacefast Zero capsule from a starter template.
EXAMPLES
$ sf zero new my-app
$ sf zero new my-app --title Todo --no-git
$ sf zero new guestbook --template guestbook
sf zero db [TARGET]Inspect or dump Zero database data.
USAGE
$ sf zero db [TARGET] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>] [--dump] [--inspect-token <value>] [--local-url <value>]
[--port <value>] [--table <value>] [--limit <value>]
ARGUMENTS
[TARGET] Space ID, slug, live URL, domain, or Zero deploy URL.
FLAGS
--dump Dump rows from the Zero database.
--inspect-token=<value> Alias for --claim-token when inspecting private anonymous deploys.
--limit=<value> Maximum rows per table for --dump (default 25, max 100).
--local-url=<value> Read database metadata from a local `sf zero dev` server.
--port=<value> Alias for local inspection at http://127.0.0.1:<port>.
--table=<value> Restrict --dump to one table.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Inspect or dump Zero database data.
Inspect or dump the local or deployed Spacefast Zero database.
EXAMPLES
$ sf zero db my-space
$ sf zero db --space my-space
$ sf zero db --port 8787 --dump
$ sf zero db --space my-space --dump --table todos
$ sf zero db --local-url http://127.0.0.1:8787 --dump
sf zero db dump [TARGET]Dump Zero database rows.
USAGE
$ sf zero db dump [TARGET] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>] [--inspect-token <value>] [--local-url <value>] [--port
<value>] [--table <value>] [--limit <value>]
ARGUMENTS
[TARGET] Space ID, slug, live URL, domain, or Zero deploy URL.
FLAGS
--inspect-token=<value> Alias for --claim-token when inspecting private anonymous deploys.
--limit=<value> Maximum rows per table to dump (default 25, max 100).
--local-url=<value> Read database rows from a local `sf zero dev` server.
--port=<value> Alias for local inspection at http://127.0.0.1:<port>.
--table=<value> Restrict the dump to one table.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Dump Zero database rows.
Dump rows from the local or deployed Spacefast Zero database.
EXAMPLES
$ sf zero db dump my-space
$ sf zero db dump --space my-space
$ sf zero db dump --port 8787
$ sf zero db dump --space my-space --table todos
$ sf zero db dump --local-url http://127.0.0.1:8787
sf zero db list [TARGET]List Zero database tables.
USAGE
$ sf zero db list [TARGET] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>] [--inspect-token <value>] [--local-url <value>] [--port
<value>]
ARGUMENTS
[TARGET] Space ID, slug, live URL, domain, or Zero deploy URL.
FLAGS
--inspect-token=<value> Alias for --claim-token when inspecting private anonymous deploys.
--local-url=<value> Read database metadata from a local `sf zero dev` server.
--port=<value> Alias for local inspection at http://127.0.0.1:<port>.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List Zero database tables.
List tables in the local or deployed Spacefast Zero database.
EXAMPLES
$ sf zero db list my-space
$ sf zero db list --space my-space
$ sf zero db list --port 8787
$ sf zero db list --local-url http://127.0.0.1:8787
sf zero db migrate [SOURCE]Plan Zero database migrations.
USAGE
$ sf zero db migrate [SOURCE] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--out
<value>] [--finalize-out <value>] [--runner-sha256 <value>] [--previous-artifact <value>] [--central-realtime-url
<value>] [--auth-sign-in-url <value>] [--auth-sign-out-url <value>] [--public-inspect] [--drop | --rename]
ARGUMENTS
[SOURCE] [default: .] Capsule source directory.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
RUNTIME FLAGS
--auth-sign-in-url=<value> Central Spacefast auth URL that starts hosted Zero WP.com sign-in.
--auth-sign-out-url=<value> Central Spacefast auth URL that signs out hosted Zero users.
--central-realtime-url=<value> Central Spacefast realtime URL for production mutation events.
--drop Allow generated Zero migration plans to include explicit drop operations.
--previous-artifact=<value> Path to a previous Zero artifact or finalize payload for update migration planning.
--public-inspect Make hosted Zero inspect metadata public. Private is the default.
--rename Allow generated Zero migration plans to include explicit rename operations.
--runner-sha256=<value> Expected sha256 digest for the prebuilt Rust runner.
OUTPUT FLAGS
--finalize-out=<value> [default: .stattic/zero/finalize.json] Path to write the runtime finalize payload.
--out=<value> [default: .stattic/zero/artifact.json] Path to write the Zero artifact manifest.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Plan Zero database migrations.
Plan Spacefast Zero database migrations from the current source tree without deploying.
EXAMPLES
$ sf zero db migrate
$ sf zero db migrate ./todo --previous-artifact .stattic/zero/previous.json
$ sf zero db migrate --drop
$ sf zero db migrate --rename
sf zero deploy [SOURCE]Build and deploy a Zero app.
USAGE
$ sf zero deploy [SOURCE] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>] [-n <value>] [--slug <value>] [--hostname-scope team|global]
[--spa auto|true|false] [-m <value>] [--git-branch <value>] [--git-commit <value>] [--git-ref <value>]
[--git-repository <value>] [--source-type direct-upload|git] [--dry-run] [--wait] [--wait-timeout <value>] [--out
<value>] [--finalize-out <value>] [--publish-out <value>] [--runner-sha256 <value>] [--previous-artifact <value>]
[--central-realtime-url <value>] [--auth-sign-in-url <value>] [--auth-sign-out-url <value>] [--public-inspect]
[--drop | --rename]
ARGUMENTS
[SOURCE] [default: .] Capsule source directory.
VERSION SOURCE FLAGS
-m, --message=<value> [env: SPACEFAST_PUBLISH_MESSAGE] Plain-language changelog entry for this version, shown
in version history. Overrides the detected git commit message.
--git-branch=<value> [env: SPACEFAST_GIT_BRANCH] Git branch name to record on the version.
--git-commit=<value> [env: SPACEFAST_GIT_COMMIT] Git commit SHA to record on the version.
--git-ref=<value> [env: SPACEFAST_GIT_REF] Git ref to record on the version.
--git-repository=<value> [env: SPACEFAST_GIT_REPOSITORY] Git repository to record on the version, for example
owner/repo.
--source-type=<option> [env: SPACEFAST_SOURCE_TYPE] Version source type to record.
<options: direct-upload|git>
SPACE METADATA FLAGS
-n, --name=<value> Set the space title.
--hostname-scope=<option> Managed hostname scope for newly created spaces.
<options: team|global>
--slug=<value> Set the space slug when creating a new space.
--spa=<option> [default: auto] Control single-page app fallback detection.
<options: auto|true|false>
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
RUNTIME FLAGS
--auth-sign-in-url=<value> Central Spacefast auth URL that starts hosted Zero WP.com sign-in.
--auth-sign-out-url=<value> Central Spacefast auth URL that signs out hosted Zero users.
--central-realtime-url=<value> Central Spacefast realtime URL for production mutation events.
--drop Allow generated Zero migration plans to include explicit drop operations.
--previous-artifact=<value> Path to a previous Zero artifact or finalize payload for update migration planning.
--public-inspect Make hosted Zero inspect metadata public. Private is the default.
--rename Allow generated Zero migration plans to include explicit rename operations.
--runner-sha256=<value> Expected sha256 digest for the prebuilt Rust runner.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
EXECUTION FLAGS
--dry-run Build and print the deploy plan without uploading files or writing remote state.
--[no-]wait Wait until queued publish work finishes before returning.
--wait-timeout=<value> [default: 900] Seconds to wait for the version to become ready.
OUTPUT FLAGS
--finalize-out=<value> [default: .stattic/zero/finalize.json] Path to write the runtime finalize payload.
--out=<value> [default: .stattic/zero/artifact.json] Path to write the Zero artifact manifest.
--publish-out=<value> [default: .stattic/zero/public] Directory to write the public Zero shell before deploying.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Build and deploy a Zero app.
Build a Spacefast Zero capsule, materialize its public shell, and deploy it to Spacefast.
EXAMPLES
$ sf zero deploy
$ sf zero deploy ./todo --space my-space
$ sf zero deploy ./todo --central-realtime-url https://realtime.spacefast.example
sf zero dev [SOURCE]Run local Zero dev server.
USAGE
$ sf zero dev [SOURCE] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--host
<value>] [--port <value>] [--state-backend memory|sqlite|mysql] [--dry-run] [--watch] [--watch-interval <value>]
ARGUMENTS
[SOURCE] [default: .] Capsule source directory.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
SERVER FLAGS
--dry-run Print the local dev server plan without starting the foreground server.
--host=<value> [default: 127.0.0.1] Host interface for the local dev server.
--port=<value> [default: 8787] Port for the local HTTP and websocket dev server.
--state-backend=<option> [default: memory] Local state adapter to advertise to the Zero client transport.
<options: memory|sqlite|mysql>
--[no-]watch Poll source files and reload the local Zero runtime after changes.
--watch-interval=<value> [default: 1000] Source polling interval in milliseconds.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Run local Zero dev server.
Run a local Spacefast Zero dev server with a foreground localhost websocket endpoint.
EXAMPLES
$ sf zero dev
$ sf zero dev --port 8787 --dry-run --json
sf zero inspect [TARGET]Inspect Zero runtime metadata.
USAGE
$ sf zero inspect [TARGET] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>] [--inspect-token <value>] [--local-url <value>] [--port
<value>]
ARGUMENTS
[TARGET] Space ID, slug, live URL, domain, or Zero deploy URL.
FLAGS
--inspect-token=<value> Alias for --claim-token when inspecting private anonymous deploys.
--local-url=<value> Read inspect metadata from a local `sf zero dev` server.
--port=<value> Alias for local inspection at http://127.0.0.1:<port>.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Inspect Zero runtime metadata.
Inspect the Spacefast Zero runtime locally or on a deployed space.
EXAMPLES
$ sf zero inspect my-space
$ sf zero inspect --space my-space
$ sf zero inspect --port 8787
$ sf zero inspect --local-url http://127.0.0.1:8787
sf zero logs [TARGET]List Zero runtime logs.
USAGE
$ sf zero logs [TARGET] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>] [--limit <value>] [--cursor <value>] [--inspect-token
<value>] [--local-url <value>] [--port <value>] [--requestId <value>] [--mutationName <value>]
ARGUMENTS
[TARGET] Space ID, slug, live URL, domain, or Zero deploy URL.
FLAGS
--cursor=<value> Pagination cursor returned by a previous request.
--inspect-token=<value> Alias for --claim-token when inspecting private anonymous deploys.
--limit=<value> [default: 50] Maximum log entries to return.
--local-url=<value> Read logs from a local `sf zero dev` server.
--mutationName=<value> Filter logs by mutation name.
--port=<value> Alias for local inspection at http://127.0.0.1:<port>.
--requestId=<value> Filter logs by request id.
SPACE SELECTION FLAGS
-o, --team=<value> [env: SPACEFAST_TEAM] Team slug, ID, or name.
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Anonymous space claim token.
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List Zero runtime logs.
List runtime logs for the local or deployed Spacefast Zero runtime.
EXAMPLES
$ sf zero logs my-space
$ sf zero logs --space my-space
$ sf zero logs --limit 25 --requestId req_123
$ sf zero logs --port 8787
$ sf zero logs --local-url http://127.0.0.1:8787
sf zero new NAMECreate a Zero app.
USAGE
$ sf zero new NAME [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--template
todo|guestbook] [--title <value>] [--no-git]
ARGUMENTS
NAME Directory name for the new capsule.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
TEMPLATE FLAGS
--no-git Do not initialize a git repository for the new capsule.
--template=<option> [default: todo] Starter template to create.
<options: todo|guestbook>
--title=<value> Display title for the starter app.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Create a Zero app.
Create a new Spacefast Zero capsule from a starter template.
EXAMPLES
$ sf zero new my-app
$ sf zero new my-app --title Todo --no-git
$ sf zero new guestbook --template guestbook
sf zero run-many [SOURCE]Run many local Zero dev servers.
USAGE
$ sf zero run-many [SOURCE] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--base-port
<value>] [--count <value>] [--host <value>] [--state-backend memory|sqlite|mysql] [--dry-run]
ARGUMENTS
[SOURCE] [default: .] Capsule source directory.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
SERVER FLAGS
--base-port=<value> [default: 4000] First local port to bind.
--count=<value> [default: 20] Number of local dev servers to start.
--dry-run Print the local dev server plans without starting foreground servers.
--host=<value> [default: 127.0.0.1] Host interface for the local dev servers.
--state-backend=<option> [default: memory] Local state adapter to advertise to each Zero client transport.
<options: memory|sqlite|mysql>
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Run many local Zero dev servers.
Run many local Spacefast Zero dev servers on consecutive localhost ports.
EXAMPLES
$ sf zero run-many
$ sf zero run-many ./todo --count 20 --base-port 4000
$ sf zero run-many --count 3 --base-port 5000 --dry-run --json
sf zero tokenManage Zero tokens.
USAGE
$ sf zero token [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Manage Zero tokens.
Manage API tokens for Zero apps using Spacefast API keys.
sf zero token createCreate a Zero token.
USAGE
$ sf zero token create [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-n <value>]
[--personal] [--preset ci_deploy|space_publisher|space_admin|site_admin|domain_manager|team_admin|billing_viewer]
FLAGS
-n, --name=<value> Human-readable token name.
--personal Create a personal token instead of the default CI deploy preset.
--preset=<option> Access preset for the new API token.
<options:
ci_deploy|space_publisher|space_admin|site_admin|domain_manager|team_admin|billing_viewer>
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Create a Zero token.
Create a Spacefast API key for Zero deploy workflows.
sf zero token listList Zero tokens.
USAGE
$ sf zero token list [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--limit <value>]
FLAGS
--limit=<value> Maximum number of API tokens to return (default 50, max 100).
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
List Zero tokens.
List Spacefast API keys usable by Zero deploy workflows.
sf zero token lsList Zero tokens.
USAGE
$ sf zero token ls [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--limit <value>]
FLAGS
--limit=<value> Maximum number of API tokens to return (default 50, max 100).
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
List Zero tokens.
List Spacefast API keys usable by Zero deploy workflows.
sf zero token revoke IDRevoke a Zero token.
USAGE
$ sf zero token revoke ID [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
ARGUMENTS
ID API token id.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Revoke a Zero token.
Revoke a Spacefast API key used by Zero deploy workflows.
sf zero token rm IDRevoke a Zero token.
USAGE
$ sf zero token rm ID [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
ARGUMENTS
ID API token id.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
GLOBAL FLAGS
--json Format output as json.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] Access token for non-interactive auth.
DESCRIPTION
Revoke a Zero token.
Revoke a Spacefast API key used by Zero deploy workflows.
sf publish [dir] [--spa auto|true|false] [--name name] [--token token] [--json]
sf publish [dir] --dry-run [--json]
sf init [--title name] [--mode website|files] [--spa auto|true|false]
sf doctor [--json]
sf spaces claim [--team team] [--token token]
sf delete [--space ref] [--json]
sf login [--token token]
sf logout
sf whoami
sf inspect [--space ref]
sf versions [--space ref]
sf rollback <version> [--space ref]
sf promote <version> [--space ref]
sf publish [dir] --build [--root-directory path] [--output-directory dist] [--skip-install] [--skip-build]
sf sync [--space ref] [--no-wait]
sf routing compute [--space ref]
sf duplicate [--space ref] [--title value] [--slug value] [--team team]
sf variables
sf variables list [--show-values]
sf variables pull [--format env|json]
sf variables set <name> <value>
sf variables delete <name>
sf domains
sf domains add <hostname> [--role standard|redirect] [--redirect-to hostname] [--no-wait]
sf domains check <domain-id-or-hostname> [--no-wait]
sf teams default [team]
sf teams members [--team team]
sf teams invitations [--team team]
sf teams invitations create <email> [--role owner|admin|member]
sf teams invitations resend <invitation>
sf teams invitations cancel <invitation>
sf metadata patch [--title value] [--mode website|files] [--spa true|false]
printf '%s\n' "$PASSWORD" | sf password set --stdin [--no-wait]
sf password clear [--no-wait]
```text
`publish` defaults to the current directory. `--spa auto` is the default and only
enables SPA fallback when the output strongly looks like a single-page app.
`delete` removes the current space selected by `.stattic/state.json`, or the
space passed with `--space`.
The CLI is oclif-native. Use `sf help` or `sf <command> --help` for
generated command docs, strict flag validation, aliases, grouped flags,
environment-variable hints, and examples. Use `sf autocomplete` to install
shell completions.
## Output and errors
Use `--json` on any Spacefast command for machine-readable output. Errors
use the same shape everywhere:
```json
{
"error": {
"code": "auth_required",
"message": "No access token available. Run `sf login` first.",
"details": {}
}
}
Stable exit codes:
0: success1: unexpected error2: validation error10: auth required or invalid token20: resource not found30: conflict40: network/API reachability failure50: wait timeoutsf doctor --json
sf teams --json
sf teams default my-team
sf init --title "Docs" --mode website
sf publish ./dist --dry-run --json
sf publish ./dist --json --wait
sf publish ./dist --space docs --json --no-wait
sf domains add docs.example.com --space docs --json --wait
```text
## Auth
Interactive login uses browser device authorization:
```bash
sf login
For CI, pass --token or set SPACEFAST_TOKEN.
Authenticated first publishes use your default team. If your account has one team, the CLI stores it automatically after login or the first authenticated publish. If you belong to multiple teams, set the default once:
sf teams default my-team
```text
You can still override a single command with `--team`.
Anonymous publishes save the claim token locally and print a browser claim URL.
To keep publishing and managing an anonymous space:
```bash
sf spaces claim
If you are not logged in, claim starts login first, then moves the saved space
into your account.
FAQs
Command-line interface for publishing and managing Spacefast spaces.
The npm package spacefast receives a total of 2,870 weekly downloads. As such, spacefast popularity was classified as popular.
We found that spacefast demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Company News
Socket is now in the AWS Security Hub Extended plan. Adopt it through AWS, apply committed spend, and block malicious open source packages.

Research
/Security News
Popular npm packages keyv and cacheable compromised.

Security News
A misconfiguration gave three Anthropic models internet access, and one, believing it was in a simulation, shipped a credential-stealing package to PyPI.