Security News
Happy Birthday, Shai-Hulud
It has been one year since Shai-Hulud made its first appearance on npm.
By Sarah Gooding - Sep 18, 2026
New:Microsoft Teams Notifications Are Now Available in Socket.Learn more →
spacefast
The Spacefast CLI shares AI artifacts, sites, build outputs, docs, reports, and 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
.spacefast/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.
Next.js builds
Automatic builds support stable Next.js 16.2.x and 16.3.x releases. Spacefast
uses the installed Next version, preserves your dependencies and lockfile, and
records the selected compatibility range, OpenNext version, and build settings
in the build log. Both lines use OpenNext 1.20.2, including its encoded
middleware and cache-path fixes. For 16.3.x, a plain next build package script
runs with --webpack; custom scripts retain their explicit build settings.
Automatic builds require a node_modules layout. Yarn Plug'n'Play is rejected
before building because its compiled server bundle does not run correctly in
the Worker runtime. For Yarn, set nodeLinker: node-modules in .yarnrc.yml and
reinstall dependencies.
Resolved output: 'export' builds publish their browser output without
OpenNext. Other builds reuse the completed Next build when bundling the server.
Next 15, pre-16.2 releases, prereleases, and unverified later release lines are
not selected automatically. Prebuilt static exports remain publishable.
The compiled-runtime acceptance command is
bun packages/cli/scripts/verify-next-compatibility.mjs from the repository root.
It checks 16.2.0, 16.2.4, 16.2.11, and 16.3.4 using real CLI archives and local
Workers requests. Pass one version to run a single case.
Telemetry
The CLI's optional anonymous event contains only the command name, CLI version,
and error class. It never contains paths, file contents, or credentials. Set
SPACEFAST_TELEMETRY_DISABLED=1 or DO_NOT_TRACK=1 to disable both the
first-run disclosure and event delivery.
Retention follows the configured analytics provider policy; this repository does not define a separate CLI telemetry retention window. See the privacy policy.
Quick Start
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
Routing Files
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.
Documentation
Tab completion
$ 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.
Working directory
$ sf --cwd ./apps/docs publish
$ 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.
Debugging
Set SF_DEBUG=1 to print diagnostics (the command that ran, and every API call
with its status, duration, and request id) to stderr, leaving --json output on
stdout intact. Quote the request id when reporting a problem — the API logs the
same id on its side.
Usage
$ npm install -g spacefast
$ sf COMMAND
running command...
$ sf (--version)
spacefast/0.1.0 darwin-arm64 node-v26.6.0
$ sf --help [COMMAND]
USAGE
$ sf COMMAND
...
Commands
sf accesssf access logout-allsf activitysf agents initsf analyticssf api METHODORPATH [PATH]sf api-keyssf api-keys createsf api-keys listsf api-keys revoke IDsf applysf authsf autocomplete [SHELL]sf build [DIR]sf builds cancel BUILDsf builds detectsf builds get BUILDsf builds logs BUILDsf builds lssf builds refresh-upload BUILDsf builds retry BUILDsf channelssf channels history [NAME]sf channels lssf commentssf comments archive COMMENTsf comments exportsf comments get COMMENTsf comments listsf comments reply COMMENTsf comments settingssf comments settings setsf comments unarchive COMMENTsf continuesf cronssf crons lssf crons run TARGETsf db [TARGET]sf db console [TARGET]sf db dump [TARGET]sf db export [TARGET]sf db migrate [SOURCE]sf designsf design generatesf devsf docs [QUERY]sf 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 pull [FILE]sf env rm NAMEsf env set NAME [VALUE]sf feedbacksf fetch [PATH]sf gitsf git buildsf git connectsf git disconnectsf git githubsf git github installationssf git github repos [INSTALLATION]sf git lssf git originsf git syncsf git updatesf help [COMMAND]sf init [NAME]sf inspect [TARGET]sf linksf loginsf logoutsf logs [TARGET] [KIND]sf mapsf mcpsf mcp installsf mcp proxysf open [TARGET]sf operations [ID]sf pagessf pages pull [TARGET]sf pages validatesf pluginssf profilessf profiles rm NAMEsf profiles set NAMEsf profiles use NAMEsf promote [VERSION]sf publish [DIR]sf redeploy [BUILD]sf rollback [VERSION]sf routingsf routing computesf routing inspectsf runtimesf runtime statussf setupsf setup agentsf sharesf share checksf share grantsf share grant edit IDsf share identitysf share identity createsf share identity grantsf share identity lssf share identity revoke CONNECTIONsf share identity update CONNECTIONsf share linksf share link copy IDsf share link createsf share link edit IDsf share link lssf share link revoke IDsf share listsf share passwordsf share password createsf share password lssf share password revoke IDsf share password rotate IDsf share peoplesf share people edit PERSONsf share people invite EMAILsf share people lssf share people remove PERSONsf share people resend PERSONsf share requestsf share request approve IDsf share request deny IDsf share request lssf share revoke IDsf share tokensf share token createsf share token lssf share token revoke IDsf share token rotate IDsf skillssf skills removesf skills statussf spacessf spaces addsf spaces claimsf spaces downloadsf spaces duplicatesf spaces getsf spaces lssf spaces rmsf spaces rotate-claimsf spaces transfer TEAMsf spaces updatesf statussf storage [TARGET]sf storage ls [TARGET]sf storage rm [ID]sf switch [TEAM]sf tagssf tags apply FILEsf tags debugsf tags releasessf tags releases get ENVIRONMENTsf tags releases rollback ENVIRONMENT REVISIONsf tags releases set ENVIRONMENT REVISIONsf tags revisionssf tags revisions abandon REVISIONsf tags revisions approve REVISIONsf tags revisions createsf tags revisions diff REVISIONsf tags revisions submit REVISIONsf tags revisions validate REVISIONsf tags templatessf teamssf teams accept INVITATIONsf teams create NAMEsf teams defaults [ROOTACCESS]sf teams invitationssf teams invitations add EMAILSsf 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 accept IDsf transfers cancel IDsf unlinksf versionssf versions get [VERSION]sf versions lssf versions rm [VERSION]sf whoami
sf access
Revoke visitor sessions.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Revoke visitor sessions.
Revoke active visitor sessions. Use `sf share` to manage who can open a space.
EXAMPLES
Revoke visitor sessions.
$ sf access
See code: src/commands/access.ts
sf access logout-all
Revoke all visitor sessions.
USAGE
$ sf access logout-all [--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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Revoke all visitor sessions.
Revoke every active private-open, share-link, and signed-in visitor session for the space.
EXAMPLES
Revoke every visitor session on the space.
$ sf access logout-all --space docs
See code: src/commands/access/logout-all.ts
sf activity
Show 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
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
See code: src/commands/activity.ts
sf agents init
Write Spacefast AGENTS.md guidance.
USAGE
$ sf agents init [--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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Write Spacefast AGENTS.md guidance.
Create or update the Spacefast AGENTS.md snippet.
EXAMPLES
Insert or refresh the Spacefast block in AGENTS.md.
$ sf agents init
See code: src/commands/agents/init.ts
sf analytics
Print 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Print runtime analytics.
Print runtime analytics series.
EXAMPLES
Print the 7-day analytics series for a space.
$ sf analytics --space docs
Use a 30-day window.
$ sf analytics --space docs --window 30d
See code: src/commands/analytics.ts
sf api METHODORPATH [PATH]
Call the Spacefast API directly.
USAGE
$ sf api METHODORPATH [PATH] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[-i <value>] [--idempotency-key <value>] [--include] [--output <value> | --raw-stdout] [--paginate]
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.
--idempotency-key=<value> Replay-safe logical-attempt key for retryable mutations.
--include Write HTTP status and safe response headers to stderr.
--output=<value> Write a non-JSON response body to a file.
--paginate Emit every page of a declared cursor-list GET as JSON Lines.
--raw-stdout Write a non-JSON response body to stdout.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Call the Spacefast API directly.
Send a signed request to the public API using the resolved profile credentials. JSON envelopes print verbatim;
non-JSON responses need --output or --raw-stdout.
EXAMPLES
$ sf api /v1/me
$ sf api GET /v1/spaces/spc_123/versions --paginate
$ sf api POST /v1/publish --input @publish.json --idempotency-key 01J-logical-attempt
$ sf api GET /v1/spaces/spc_123/versions/ver_123/archive --output site.tar.gz
See code: src/commands/api.ts
sf api-keys
Manage 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Manage API keys.
Manage API keys.
EXAMPLES
Manage API keys.
$ sf api-keys
See code: src/commands/api-keys.ts
sf api-keys create
Create 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|domain_manager|team_admin|billing_viewer|partner_admin]
FLAGS
-n, --name=<value> Human-readable API key name.
--preset=<option> [default: space_publisher] Access preset for the new API key.
<options:
ci_deploy|space_publisher|space_admin|domain_manager|team_admin|billing_viewer|partner_admin>
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Create an API key.
Create an API key and print its one-time secret.
ALIASES
$ sf api-keys add
EXAMPLES
Create an API key and print its one-time secret.
$ sf api-keys create --name ci
Create a key with a specific access preset.
$ sf api-keys create --name ci --preset full_access
See code: src/commands/api-keys/create.ts
sf api-keys list
List API keys.
USAGE
$ sf api-keys list [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-o <value>] [--limit
<value>]
FLAGS
--limit=<value> Maximum number of API keys to return (default 50, max 100).
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
List API keys.
List API keys for the selected team.
ALIASES
$ sf api-keys ls
EXAMPLES
List API keys for the selected team.
$ sf api-keys ls
See code: src/commands/api-keys/list.ts
sf api-keys revoke ID
Revoke 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Revoke an API key.
Revoke an API key.
ALIASES
$ sf api-keys delete
$ sf api-keys remove
$ sf api-keys rm
EXAMPLES
Revoke an API key by ID.
$ sf api-keys revoke key_123
See code: src/commands/api-keys/revoke.ts
sf apply
Apply saved changes to the live runtime.
USAGE
$ sf apply [--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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
EXECUTION FLAGS
--[no-]wait Wait until queued work finishes before returning.
--wait-timeout=<value> [default: 900] Seconds to wait for the apply to finish.
DESCRIPTION
Apply saved changes to the live runtime.
Push saved space settings that are not live yet onto the serving runtime.
EXAMPLES
Apply the linked space's saved changes and wait for them to go live.
$ sf apply
Queue an apply for a specific space without waiting.
$ sf apply --space docs --no-wait
See code: src/commands/apply.ts
sf auth
Authenticate the CLI.
USAGE
$ sf auth [--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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Authenticate the CLI.
Authenticate the CLI with Spacefast.
EXAMPLES
$ sf auth login
See code: src/commands/auth.ts
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 project 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] [--output <value>] [--dry-run] [--stream]
ARGUMENTS
[DIR] Project directory to build. Defaults to the current directory.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--json Format output as json.
--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.
EXECUTION FLAGS
--dry-run Print the detected build plan without installing, building, or packing.
--output=<value> [default: .spacefast/build-output.tgz] Archive path to write.
--[no-]stream With --json, emit a JSONL build event stream. Use --no-stream for a single result blob.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Build and pack project output.
Detect build settings, run the build, and pack its output. A zero runtime compiles the capsule instead and leaves the
app shell `sf publish` would upload.
EXAMPLES
Detect build settings, run the build, and pack the output archive.
$ sf build
Build a monorepo app and write the archive to a custom path.
$ sf build --root-directory apps/web --output ./apps/web.tgz
See code: src/commands/build.ts
sf builds cancel BUILD
Cancel 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Cancel a build.
Cancel a build. Idempotent: a build already in a terminal state is returned unchanged.
EXAMPLES
$ sf builds cancel bld_123
See code: src/commands/builds/cancel.ts
sf builds detect
Detect framework and build settings.
USAGE
$ sf builds detect [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--connection-type connected|hosted] [--ref <value>] [--root-directory
<value>] [--apply-best]
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
BUILD FLAGS
--apply-best Save the highest-ranked detected app candidate as repository build settings.
--root-directory=<value> App root directory to inspect.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
REPOSITORY FLAGS
--connection-type=<option> [default: connected] Repository connection type.
<options: connected|hosted>
--ref=<value> Git ref to inspect.
DESCRIPTION
Detect framework and build settings.
Detect the framework and build settings for a space's repository connection. Shows the detected app, ranked candidates
when the repository has more than one, and unsupported platform config found along the way.
EXAMPLES
Show detected framework and build settings for the repository connection.
$ sf builds detect --space docs
Detect and save the best build settings for a subdirectory.
$ sf builds detect --space docs --root-directory apps/web --apply-best
See code: src/commands/builds/detect.ts
sf builds get BUILD
Show 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Show a build.
Fetch a build by id.
EXAMPLES
Show a build by ID.
$ sf builds get bld_123
See code: src/commands/builds/get.ts
sf builds logs BUILD
Print 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Print build logs.
Print build runner log lines, newest first.
EXAMPLES
Print recent log lines for a build.
$ sf builds logs bld_123
Stream logs until the build finishes.
$ sf builds logs bld_123 --follow
See code: src/commands/builds/logs.ts
sf builds ls
List 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
List builds.
List a space's builds, newest first.
ALIASES
$ sf builds list
EXAMPLES
List recent builds for a space.
$ sf builds ls --space docs
Show only the five most recent builds.
$ sf builds ls --space docs --limit 5
See code: src/commands/builds/ls.ts
sf builds refresh-upload BUILD
Refresh source archive upload.
USAGE
$ sf builds refresh-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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Refresh source archive upload.
Refresh the upload instruction for a build waiting on its source archive.
EXAMPLES
Refresh the source archive upload instruction for a build.
$ sf builds refresh-upload bld_123
See code: src/commands/builds/refresh-upload.ts
sf builds retry BUILD
Retry 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Retry a terminal build.
Retry a terminal build with the same input, settings, and target.
EXAMPLES
$ sf builds retry bld_123
See code: src/commands/builds/retry.ts
sf channels
Manage 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Manage channels.
List channels and inspect their promotion history.
EXAMPLES
Manage channels.
$ sf channels
See code: src/commands/channels.ts
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Show channel history.
Show what this channel has gone live with, newest first.
EXAMPLES
Show promotion history for the live channel.
$ sf channels history --space docs
Show promotion history for the preview channel.
$ sf channels history preview --space docs
See code: src/commands/channels/history.ts
sf channels ls
List 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
List channels.
List channels for a space and where each one points.
ALIASES
$ sf channels list
EXAMPLES
List channels for the docs space.
$ sf channels ls --space docs
See code: src/commands/channels/ls.ts
sf comments
Manage comments.
USAGE
$ sf comments
DESCRIPTION
Manage comments.
List, export, and update persistent Space comments, and set where Comments run.
EXAMPLES
Manage comments.
$ sf comments
See code: src/commands/comments.ts
sf comments archive COMMENT
Archive a comment.
USAGE
$ sf comments archive COMMENT [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>]
ARGUMENTS
COMMENT Comment id, for example cmt_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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Archive a comment.
Archive a comment thread.
EXAMPLES
$ sf comments archive cmt_123
See code: src/commands/comments/archive.ts
sf comments export
Export comments.
USAGE
$ sf comments export [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--version <value>] [--format markdown|json] [--status open|archived]
FLAGS
--format=<option> [default: markdown] Export format.
<options: markdown|json>
--status=<option> Filter by status.
<options: open|archived>
--version=<value> Filter by 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Export comments.
Export comment threads for agents and scripts.
EXAMPLES
Export every open thread in the space as markdown.
$ sf comments export --status open --format markdown
Export open comments filtered to version v3 as JSON.
$ sf comments export --version v3 --status open --format json
See code: src/commands/comments/export.ts
sf comments get COMMENT
Show a comment.
USAGE
$ sf comments get COMMENT [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>]
ARGUMENTS
COMMENT Comment id, for example cmt_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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Show a comment.
Show one comment thread.
EXAMPLES
$ sf comments get cmt_123
See code: src/commands/comments/get.ts
sf comments list
List comments.
USAGE
$ sf comments list [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--version <value>] [--status open|archived] [--path <value>] [--limit
<value>]
FLAGS
--limit=<value> Maximum comments to return.
--path=<value> Filter by page path.
--status=<option> Filter by status.
<options: open|archived>
--version=<value> Filter by 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
List comments.
List persistent comment threads across a space.
ALIASES
$ sf comments ls
EXAMPLES
List open comments on the pricing route across publishes.
$ sf comments list --status open --path /pricing
Filter comments by their version context.
$ sf comments list --version v3
See code: src/commands/comments/list.ts
sf comments reply COMMENT
Reply to a comment.
USAGE
$ sf comments reply COMMENT --body <value> [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>] [--idempotency-key <value>]
ARGUMENTS
COMMENT Comment id, for example cmt_123.
FLAGS
--body=<value> (required) Reply body.
--idempotency-key=<value> Stable key for safely retrying this reply.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Reply to a comment.
Reply to a comment thread.
EXAMPLES
$ sf comments reply cmt_123 --body "Fixed in v4."
See code: src/commands/comments/reply.ts
sf comments settings
Show Comments settings.
USAGE
$ sf comments settings [--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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Show Comments settings.
Show where Comments run for a Space and which third-party sites may embed them. Change them with `comments settings
set`.
EXAMPLES
Show Comments settings for the linked Space.
$ sf comments settings
See code: src/commands/comments/settings.ts
sf comments settings set
Change Comments settings.
USAGE
$ sf comments settings set [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--surface off|previews|everywhere] [--embed-allow <value>...]
[--embed-remove <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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
EMBEDDING FLAGS
--embed-allow=<value>... Site allowed to embed this Space's Comments, e.g. https://docs.example.com.
--embed-remove=<value>... Site to cut off from embedding this Space's Comments.
COMMENTS FLAGS
--surface=<option> Where Comments run: off, previews, or everywhere.
<options: off|previews|everywhere>
DESCRIPTION
Change Comments settings.
Change where Comments run and which third-party sites may embed them. Allowing a site lets it create anonymous
commenters in this Space's rooms, so allowlist changes confirm first.
EXAMPLES
Run Comments on version previews and the live Space.
$ sf comments settings set --surface everywhere
Let docs.example.com embed this Space's Comments.
$ sf comments settings set --embed-allow https://docs.example.com
Cut docs.example.com off from this Space's Comments.
$ sf comments settings set --embed-remove https://docs.example.com
See code: src/commands/comments/settings/set.ts
sf comments unarchive COMMENT
Unarchive a comment.
USAGE
$ sf comments unarchive COMMENT [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>]
ARGUMENTS
COMMENT Comment id, for example cmt_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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Unarchive a comment.
Unarchive a comment thread.
EXAMPLES
$ sf comments unarchive cmt_123
See code: src/commands/comments/unarchive.ts
sf continue
Continue publishing after claim.
USAGE
$ sf continue [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token <value>]
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Continue publishing after claim.
Exchange a saved space key for a durable space API key once the space is claimed.
EXAMPLES
Continue publishing to the claimed space saved in this directory.
$ sf continue
See code: src/commands/continue.ts
sf crons
Manage scheduled jobs.
USAGE
$ sf crons [--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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Manage scheduled jobs.
Inspect and exercise a space's scheduled jobs.
EXAMPLES
Manage scheduled jobs.
$ sf crons
See code: src/commands/crons.ts
sf crons ls
List scheduled jobs.
USAGE
$ sf crons 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
List scheduled jobs.
List the scheduled jobs the live version declares, with the last failure reported for each. Crons are declared in
sf.jsonc, so publishing is how you change them.
ALIASES
$ sf crons list
EXAMPLES
List scheduled jobs for the docs space.
$ sf crons ls --space docs
See code: src/commands/crons/ls.ts
sf crons run TARGET
Run a scheduled job now.
USAGE
$ sf crons run TARGET [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--header <value>...]
ARGUMENTS
TARGET Cron key or path, as shown by `sf crons ls`.
FLAGS
--header=<value>... Request header as 'name: value'. Repeat for multiple headers.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Run a scheduled job now.
Request the declared path over HTTPS now, without waiting for the schedule. The platform's own cron header cannot be
sent, so a handler that checks CRON_SECRET needs --header 'authorization: Bearer <secret>'. Exits non-zero when the
path answers 400 or worse.
EXAMPLES
Request the path declared for the digest job.
$ sf crons run /api/digest
Run a job whose handler checks the shared secret.
$ sf crons run api-digest --header "authorization: Bearer $CRON_SECRET"
See code: src/commands/crons/run.ts
sf db [TARGET]
Inspect a space's database.
USAGE
$ sf db [TARGET] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>] [--local-url <value>] [--port <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.
--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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
RUNTIME FLAGS
--local-url=<value> Read from a local `sf dev` server instead of the live version.
--port=<value> Local `sf dev` server port; shorthand for --local-url http://127.0.0.1:<port>.
DESCRIPTION
Inspect a space's database.
Show the tables, columns, and pending migration plan of a space's database.
EXAMPLES
Inspect the linked space's database.
$ sf db
Inspect space `docs`.
$ sf db docs
Inspect the database of a running `sf dev` server.
$ sf db --port 4173
See code: src/commands/db.ts
sf db console [TARGET]
Open a database console.
USAGE
$ sf db console [TARGET] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>] [--show-secret]
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.
--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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
OPEN FLAGS
--show-secret Print the single-use console URL instead of opening it.
DESCRIPTION
Open a database console.
Open a phpMyAdmin console on the space's database, for anything `sf db` and `sf db dump` cannot answer. The URL grants
full SQL authority, so it opens in a browser instead of printing.
EXAMPLES
Open the console in a browser.
$ sf db console
Print the single-use console URL instead of opening it.
$ sf db console --show-secret
See code: src/commands/db/console.ts
sf db dump [TARGET]
Dump database rows.
USAGE
$ sf db dump [TARGET] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>] [--local-url <value>] [--port <value>] [--table <value>]
[--limit <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.
--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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
RUNTIME FLAGS
--limit=<value> Maximum rows per table (default 25, max 100).
--local-url=<value> Read from a local `sf dev` server instead of the live version.
--port=<value> Local `sf dev` server port; shorthand for --local-url http://127.0.0.1:<port>.
--table=<value> Restrict the dump to one table.
DESCRIPTION
Dump database rows.
Print rows from a space's database, for debugging and export.
EXAMPLES
Dump every declared table.
$ sf db dump
Dump one table, up to 100 rows.
$ sf db dump --table todos --limit 100
See code: src/commands/db/dump.ts
sf db export [TARGET]
Export a complete database backup.
USAGE
$ sf db export [TARGET] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>] [--local-url <value>] [--port <value>] [--out <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.
--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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
RUNTIME FLAGS
--local-url=<value> Read from a local `sf dev` server instead of the live version.
--port=<value> Local `sf dev` server port; shorthand for --local-url http://127.0.0.1:<port>.
OUTPUT FLAGS
--out=<value> Backup file path (default spacefast-backup-<space>-<timestamp>.json).
DESCRIPTION
Export a complete database backup.
Export every declared table to one versioned JSON backup. Rows are read in stable keyset pages and the destination is
replaced only after the complete export succeeds.
EXAMPLES
Export the linked space.
$ sf db export
Export a selected space to a named file.
$ sf db export docs --out ./docs-backup.json
Export a running local Zero capsule.
$ sf db export --port 4173
See code: src/commands/db/export.ts
sf db migrate [SOURCE]
Apply database schema migrations.
USAGE
$ sf db migrate [SOURCE] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>] [--previous-artifact <value>] [--drop | --rename]
ARGUMENTS
[SOURCE] [default: .] Capsule source 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
RUNTIME FLAGS
--drop Allow the planned migration to include explicit drop operations.
--previous-artifact=<value> Diff against this artifact or finalize payload instead of the live schema.
--rename Allow the planned migration to include explicit rename operations.
DESCRIPTION
Apply database schema migrations.
Apply the live version's schema migrations, and report what this source tree would change on top of them. Zero
capsules only: a worker declares no schema.
EXAMPLES
Re-apply the live capsule's migration plan.
$ sf db migrate
Allow destructive operations in the plan computed from this source tree.
$ sf db migrate --drop
See code: src/commands/db/migrate.ts
sf design
Generate design files from DESIGN.md.
USAGE
$ sf design [--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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Generate design files from DESIGN.md.
Generate committed presentation files (theme.json and _layout.html) from an authoring-time DESIGN.md.
EXAMPLES
Generate design files from DESIGN.md.
$ sf design
See code: src/commands/design.ts
sf design generate
Generate theme and layout files from DESIGN.md.
USAGE
$ sf design generate [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-f]
EXECUTION FLAGS
-f, --force Overwrite existing generated files.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Generate theme and layout files from DESIGN.md.
Read DESIGN.md's ```theme.json``` and ```layout.html``` fenced blocks and write theme.json plus _layout.html.
theme.json can seed Pages tokens; _layout.html provides site chrome. DESIGN.md itself is never read at finalize or
serve time.
EXAMPLES
Generate theme.json/_layout.html from DESIGN.md in the current directory.
$ sf design generate
Regenerate, overwriting any existing theme.json/_layout.html.
$ sf design generate --force
See code: src/commands/design/generate.ts
sf dev
Start the local dev server.
USAGE
$ sf dev [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-p <value>] [-d
<value>] [--host <value>] [--allow-network] [--state-backend memory|sqlite] [--watch] [--watch-interval <value>]
[--dry-run]
FLAGS
-d, --dir=<value> [default: .] Project directory.
-p, --port=<value> [default: 4173] Preview port.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
RUNTIME FLAGS
--allow-network Allow an explicit non-loopback runtime dev-server binding.
--dry-run Print the dev server plan without starting it.
--host=<value> [default: 127.0.0.1] Host interface for the local dev server.
--state-backend=<option> [default: memory] Local state adapter for a runtime dev server.
<options: memory|sqlite>
--[no-]watch Poll source files and reload the runtime after changes.
--watch-interval=<value> [default: 1000] Source polling interval in milliseconds.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Start the local dev server.
Run this project locally. A zero runtime starts the capsule dev server; anything else previews Pages with sample data
and the publish-time expander.
EXAMPLES
Start the local dev server.
$ sf dev
See code: src/commands/dev.ts
sf docs [QUERY]
Search the bundled docs (offline).
USAGE
$ sf docs [QUERY...] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--full]
[--all]
ARGUMENTS
[QUERY...] Search terms, or an exact topic slug to print (e.g. `publish`).
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
DISCLOSURE FLAGS
--all Include every doc, reference tier included.
--full Include full-tier docs (everything but advanced reference).
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Search the bundled docs (offline).
Search the bundled docs offline: guides, CLI, API reference, and recipes. An exact topic slug prints that page.
EXAMPLES
List the essential docs.
$ sf docs
Search docs for `rollback`.
$ sf docs rollback
Print the `publishing` topic.
$ sf docs publishing
Search across the full docs set.
$ sf docs domains --full
Every doc as machine-readable JSON.
$ sf docs --all --json
See code: src/commands/docs.ts
sf doctor
Diagnose 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Diagnose Spacefast CLI setup.
Check local CLI state, auth, API reachability, and space selection for the current directory.
EXAMPLES
Diagnose CLI state, auth, and API reachability.
$ sf doctor
Also check the health of a specific space.
$ sf doctor --space docs
See code: src/commands/doctor.ts
sf domains
Manage 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Manage domains.
Manage space domains.
EXAMPLES
Manage domains.
$ sf domains
See code: src/commands/domains.ts
sf domains add HOSTNAME
Attach 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|primary|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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
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; primary makes it the space's main address.
<options: standard|primary|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.
ALIASES
$ sf domains create
EXAMPLES
Attach a domain to a space.
$ sf domains add example.com --space docs
Attach a domain and make it the space's primary address.
$ sf domains add example.com --space docs --role primary
Attach a redirect domain.
$ sf domains add www.example.com --space docs --role redirect --redirect-to example.com
See code: src/commands/domains/add.ts
sf domains check DOMAIN
Check 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
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.
EXAMPLES
Queue a DNS readiness check for a domain.
$ sf domains check example.com --space docs
See code: src/commands/domains/check.ts
sf domains diagnostics DOMAIN
Inspect 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Inspect domain diagnostics.
Read live DNS and SSL diagnostics for an attached domain.
EXAMPLES
$ sf domains diagnostics app.example.com --space docs
See code: src/commands/domains/diagnostics.ts
sf domains dns
Manage 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key 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`.
EXAMPLES
Manage domain DNS records.
$ sf domains dns
See code: src/commands/domains/dns.ts
sf domains dns add DOMAIN
Add 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Add a DNS record.
Add a DNS record to the domain's Spacefast-managed zone.
ALIASES
$ sf domains dns create
EXAMPLES
$ sf domains dns add example.com --type MX --name @ --value mail.example.com --priority 10
See code: src/commands/domains/dns/add.ts
sf domains dns batch DOMAIN
Apply 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key 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"}]}'
See code: src/commands/domains/dns/batch.ts
sf domains dns capabilities DOMAIN
Show 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Show DNS capabilities.
Show DNS provider capabilities for a domain.
EXAMPLES
$ sf domains dns capabilities example.com
See code: src/commands/domains/dns/capabilities.ts
sf domains dns export DOMAIN
Export 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Export the DNS zone.
Print the domain's zone as BIND-style records.
EXAMPLES
Print the domain zone as BIND-style records.
$ sf domains dns export example.com
See code: src/commands/domains/dns/export.ts
sf domains dns ls DOMAIN
List 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
List DNS records.
List DNS records in the domain's Spacefast-managed zone.
ALIASES
$ sf domains dns list
EXAMPLES
List DNS records in the managed zone.
$ sf domains dns ls example.com
See code: src/commands/domains/dns/ls.ts
sf domains dns refresh DOMAIN
Refresh 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Refresh DNS provider snapshot.
Refresh a connected DNS provider snapshot for a domain.
EXAMPLES
Refresh the connected DNS provider snapshot.
$ sf domains dns refresh example.com
See code: src/commands/domains/dns/refresh.ts
sf domains dns rm DOMAIN RECORD
Delete 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Delete a DNS record.
Delete a DNS record from the domain's zone.
ALIASES
$ sf domains dns remove
$ sf domains dns delete
EXAMPLES
Delete a DNS record from the zone.
$ sf domains dns rm example.com rec_123
See code: src/commands/domains/dns/rm.ts
sf domains dns update DOMAIN RECORD
Update 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Update a DNS record.
Update fields on an existing DNS record.
EXAMPLES
Update a DNS record's value and TTL.
$ sf domains dns update example.com rec_123 --value 1.2.3.4 --ttl 3600
See code: src/commands/domains/dns/update.ts
sf domains ls
List 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
List space domains.
List domains attached to a space.
ALIASES
$ sf domains list
EXAMPLES
$ sf domains ls --space docs
See code: src/commands/domains/ls.ts
sf domains nameservers DOMAIN
Show 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Show domain nameservers.
Show the DNS mode and nameserver set for a domain.
EXAMPLES
Show the DNS mode and nameservers for a domain.
$ sf domains nameservers example.com
See code: src/commands/domains/nameservers.ts
sf domains nameservers set DOMAIN NAMESERVERS
Set 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key 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
See code: src/commands/domains/nameservers/set.ts
sf domains rm DOMAIN
Remove 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
EXECUTION FLAGS
--[no-]wait Wait until queued work finishes before returning.
DESCRIPTION
Remove a domain.
Remove a domain assignment from a space.
ALIASES
$ sf domains remove
$ sf domains delete
EXAMPLES
Remove a domain from a space after confirmation.
$ sf domains rm example.com --space docs
See code: src/commands/domains/rm.ts
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Search domain names.
Search domain ideas locally, with optional live availability checks in interactive mode.
EXAMPLES
Print local domain name ideas for a brand.
$ sf domains search acme
Open the interactive domain search with live availability.
$ sf domains search acme --interactive
See code: src/commands/domains/search.ts
sf env
Manage 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Manage env vars.
Manage space environment variables.
EXAMPLES
Manage env vars.
$ sf env
See code: src/commands/env.ts
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key 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.
EXAMPLES
Print a dotenv import template from platform config in the current directory.
$ sf env export-template
Emit the import template as JSON.
$ sf env export-template ./app --format json
See code: src/commands/env/export-template.ts
sf env import FILE
Import 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.
--[no-]secret Keep imported values write-only. New values default write-only; updates preserve existing
classifications.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Import variables from a .env file.
Import variables from a dotenv file. Values are sent to the API and are not printed back.
EXAMPLES
Import write-only variables from a .env file.
$ sf env import .env --space docs
Explicitly import readable ordinary values.
$ sf env import public.env --space docs --no-secret
See code: src/commands/env/import.ts
sf env ls
List 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
List space variables.
List space variables.
ALIASES
$ sf env list
EXAMPLES
List space variables (values masked).
$ sf env ls --space docs
See code: src/commands/env/ls.ts
sf env pull [FILE]
Pull variables.
USAGE
$ sf env pull [FILE] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--format env|json] [--force] [--stdout]
ARGUMENTS
[FILE] File to write the pulled variables to. Defaults to .env.local.
FLAGS
--force Overwrite the target file if it already exists.
--format=<option> [default: env] Output format.
<options: env|json>
--stdout Print variables to stdout instead of writing a 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Pull variables.
Pull effective space and shared variables into a local env file (default .env.local). Refuses to overwrite an existing
file unless --force.
EXAMPLES
Write variables to .env.local.
$ sf env pull --space docs
Write variables to .env.development, replacing an existing file.
$ sf env pull .env.development --space docs --force
Print variables in .env format to stdout.
$ sf env pull --space docs --stdout > .env
Print variables as JSON.
$ sf env pull --space docs --stdout --format json
See code: src/commands/env/pull.ts
sf env rm NAME
Delete 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Delete a space variable.
Delete a space variable.
ALIASES
$ sf env remove
$ sf env delete
EXAMPLES
Delete a space variable after confirmation.
$ sf env rm API_URL --space docs
See code: src/commands/env/rm.ts
sf env set NAME [VALUE]
Set 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>] [--value-from-stdin] [--secret] [--production-value <value>]
[--preview-value <value>] [--branch-value <value>...]
ARGUMENTS
NAME Variable name.
[VALUE] Variable value. Omit it and pass --value-from-stdin for secrets.
FLAGS
--[no-]secret Keep the value write-only. New values default write-only; updates preserve the existing
classification.
--value-from-stdin Read the value from standard input, keeping it out of your shell history and process list.
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.
--json Format output as json.
--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] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Set a space variable.
Create or update a space variable. Values are sent to the API and are not printed back. Pipe secrets in with
--value-from-stdin to keep them out of your shell history.
EXAMPLES
Set a write-only space variable without putting it in the command line.
printf %s "$API_TOKEN" | sf env set API_TOKEN --value-from-stdin --space docs
Explicitly set a readable ordinary value.
$ sf env set PUBLIC_ORIGIN https://www.example.com --no-secret --space docs
See code: src/commands/env/set.ts
sf feedback
Send feedback to Spacefast.
USAGE
$ sf feedback -m <value> [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--category
bug|docs|limit|idea|other] [--error-code <value>] [--request-id <value>] [--space-id <value>] [--url <value>]
FLAGS
-m, --message=<value> (required) Feedback message.
--category=<option> [default: other] Feedback category.
<options: bug|docs|limit|idea|other>
--error-code=<value> Related API error code.
--request-id=<value> Related API request id.
--space-id=<value> Related space id.
--url=<value> Related URL.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Send feedback to Spacefast.
Send feedback to Spacefast with optional error, request, space, or URL context.
EXAMPLES
Send docs feedback.
$ sf feedback -m "The continuation docs are unclear" --category docs
Send machine-readable feedback with error context.
$ sf feedback -m "Publish failed after claim" --category bug --error-code space_claimed_credential_available \
--request-id req_123 --json
See code: src/commands/feedback.ts
sf fetch [PATH]
Fetch private content.
USAGE
$ sf fetch [PATH] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--headers] [--output <value>] [--status] [--verify <value>]
ARGUMENTS
[PATH] Canonical route to fetch. Defaults to /.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
VERIFICATION FLAGS
--headers Include response headers, excluding credential-bearing headers.
--status Report the HTTP status without requiring a body output file.
--verify=<value> Require a successful response serving this exact version ID.
OUTPUT FLAGS
--output=<value> File to write the response body into.
DESCRIPTION
Fetch private content.
Fetch private Space content through the same central exchange and host-only cookie flow as a browser.
EXAMPLES
Fetch /docs from the linked Space.
$ sf fetch /docs --output ./docs.html
Inspect an authenticated response without writing its body.
$ sf fetch / --status --headers --json
Verify that a private route serves an exact published version.
$ sf fetch / --verify ver_123 --json
See code: src/commands/fetch.ts
sf git
Manage repository connections.
USAGE
$ sf git [--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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Manage repository connections.
Manage repository connections and Git push deploys.
EXAMPLES
Manage repository connections.
$ sf git
See code: src/commands/git.ts
sf git build
Build 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>] [--config <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.
--json Format output as json.
--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 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.
--config=<value> [env: SPACEFAST_CONFIG] Path to an sf.jsonc file with repository build settings.
--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] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
REPOSITORY FLAGS
--connection-type=<option> [default: connected] Repository connection type.
<options: connected|hosted>
DESCRIPTION
Build repository source.
Trigger a generic remote build from a repository connection.
EXAMPLES
Trigger a remote build from the main ref.
$ sf git build --space docs --ref main
Build a preview branch and wait for it to finish.
$ sf git build --space docs --branch preview --target preview --wait
See code: src/commands/git/build.ts
sf git connect
Connect 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>] [--detect-urls] [--installation-id <value>] [--credential <value>] [--default-branch
<value>] [--production-branch <value>] [--ref <value>] [--config <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.
--json Format output as json.
--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.
--config=<value> [env: SPACEFAST_CONFIG] Path to an sf.jsonc file with repository build settings.
--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] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key 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.
--[no-]detect-urls Detect clone and upstream URLs from the origin remote.
--installation-id=<value> [env: SPACEFAST_REPOSITORY_INSTALLATION_ID] GitHub App installation ID. Resolved from
your installations when omitted; pass it to pick one when several grant the repository.
--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. Resolved from GitHub when omitted.
--repository-name=<value> Repository name from the host.
--upstream-url=<value> Upstream repository URL.
DESCRIPTION
Connect repository.
Create or replace a repository connection. GitHub connections resolve their installation and repository IDs from your
GitHub App installations, so --repository owner/repo is enough.
EXAMPLES
Connect a GitHub repository.
$ sf git connect --space docs --provider github --repository owner/repo
Pick the installation when more than one grants the repository.
$ sf git connect --space docs --provider github --repository owner/repo --installation-id 12345678
Connect a repository, set the production branch, and sync.
$ sf git connect --space docs --repository owner/repo --production-branch main --sync
See code: src/commands/git/connect.ts
sf git disconnect
Disconnect 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
REPOSITORY FLAGS
--connection-type=<option> [default: connected] Repository connection type.
<options: connected|hosted>
DESCRIPTION
Disconnect repository.
Delete a repository connection.
EXAMPLES
Delete the repository connection.
$ sf git disconnect --space docs
See code: src/commands/git/disconnect.ts
sf git github
Manage GitHub App setup.
USAGE
$ sf git github [--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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Manage GitHub App setup.
Inspect GitHub App installations and repositories.
EXAMPLES
Manage GitHub App setup.
$ sf git github
See code: src/commands/git/github.ts
sf git github installations
List GitHub installations.
USAGE
$ sf git github installations [--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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
List GitHub installations.
List GitHub App installations available to the current user.
EXAMPLES
List GitHub App installations for the current user.
$ sf git github installations
See code: src/commands/git/github/installations.ts
sf git github repos [INSTALLATION]
List GitHub repositories.
USAGE
$ sf git github repos [INSTALLATION] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>]
ARGUMENTS
[INSTALLATION] GitHub App installation 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
List GitHub repositories.
List repositories available to a GitHub App installation.
EXAMPLES
List repositories for a GitHub App installation.
$ sf git github repos 12345678
See code: src/commands/git/github/repos.ts
sf git ls
Show 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
REPOSITORY FLAGS
--connection-type=<option> [default: connected] Repository connection type.
<options: connected|hosted>
DESCRIPTION
Show repository connection.
Show a repository connection.
EXAMPLES
Show the repository connection.
$ sf git ls --space docs
See code: src/commands/git/ls.ts
sf git origin
Install 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
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
See code: src/commands/git/origin.ts
sf git sync
Sync remote repository source.
USAGE
$ sf git sync [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--connection-type connected|hosted] [--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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
REPOSITORY FLAGS
--connection-type=<option> [default: connected] Repository connection type.
<options: connected|hosted>
--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.
EXAMPLES
Sync the upstream repository for the space.
$ sf git sync --space docs
Sync a specific ref.
$ sf git sync --space docs --ref main
See code: src/commands/git/sync.ts
sf git update
Update 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] [--config <value>] [--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.
--json Format output as json.
--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.
--config=<value> [env: SPACEFAST_CONFIG] Path to an sf.jsonc file with repository build settings.
--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] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key 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.
DESCRIPTION
Update repository connection.
Update a repository connection.
EXAMPLES
Change the production branch on the repository connection.
$ sf git update --space docs --production-branch main
See code: src/commands/git/update.ts
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.
EXAMPLES
Display help for sf.
$ sf help [command]
See code: @oclif/plugin-help
sf init [NAME]
Create a Spacefast project.
USAGE
$ sf init [NAME] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [-f] [--runtime static|zero|functions] [--template todo|guestbook|contact]
[--title <value>] [--no-git]
ARGUMENTS
[NAME] Directory name for a new project. Omit to initialize the current directory.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
ZERO FLAGS
--no-git Skip initializing git for a Zero starter app.
--template=<option> Zero starter template to scaffold.
<options: todo|guestbook|contact>
--title=<value> Zero starter app title.
PROJECT FLAGS
--runtime=<option> [default: static] Project runtime to scaffold.
<options: static|zero|functions>
DESCRIPTION
Create a Spacefast project.
Create a Spacefast project, in a new directory when given a name and in the current one otherwise. Use --runtime to
scaffold a Zero capsule or a Functions worker instead of a static config.
EXAMPLES
Write a starter sf.jsonc in the current directory.
$ sf init
Create a new project directory named my-site.
$ sf init my-site
Initialize config and link the current directory to space `docs`.
$ sf init --space docs
Scaffold a Zero capsule in a new directory.
$ sf init my-app --runtime zero --template guestbook
Scaffold a Functions worker in the current directory.
$ sf init --runtime functions
See code: src/commands/init.ts
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key 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://spacefast.com
Inspect by ID in a specific team.
$ sf inspect spc_abc123 --team acme
See code: src/commands/inspect.ts
sf link
Link 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Link the current directory to a space.
Resolve an existing space by --space and save it to .spacefast/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
See code: src/commands/link.ts
sf login
Log in to Spacefast.
USAGE
$ sf login [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--handoff] [-o
<value>]
FLAGS
--handoff Redeem a one-use agent handoff link from the dashboard. Read from stdin: pipe it or paste it at the hidden
prompt, never as an argument.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Log in to Spacefast.
Log this machine in through the browser, or save an API key you already have.
ALIASES
$ sf auth login
EXAMPLES
Start browser-assisted device login.
$ sf login
Store a token for non-interactive use.
$ sf login --token st_...
Redeem a one-use dashboard handoff link through stdin.
printf '%s\n' "$HANDOFF_LINK" | sf login --handoff
See code: src/commands/login.ts
sf logout
Log 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Log out of Spacefast.
Delete the local login and revoke the CLI-minted token when possible.
EXAMPLES
Log out and revoke the local CLI token.
$ sf logout
See code: src/commands/logout.ts
sf logs [TARGET] [KIND]
Read a space's request and handler logs.
USAGE
$ sf logs [TARGET] [KIND] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>] [--limit <value>] [-f] [--cursor <value>] [--request-id
<value>] [--handler <value>]
ARGUMENTS
[TARGET] Space ID, slug, live URL, or domain. Defaults to the linked space.
[KIND] Log kind: `access` for requests the edge served, `runtime` for what your code logged. Defaults to access.
FLAGS
-f, --follow Poll for new log entries every 2 seconds until interrupted (Ctrl-C).
--cursor=<value> Continue from the cursor printed by the previous page.
--handler=<value> Runtime logs only: lines from one Zero mutation or Functions handler.
--limit=<value> [default: 50] Maximum number of log entries.
--request-id=<value> Runtime logs only: everything logged while serving one request.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Read a space's request and handler logs.
Read a space's logs. `access` is every request the edge served; `runtime` is what your code logged, with the request
id and handler for each line. Runtime lines are indexed after the response returns, so a line you just triggered takes
a while to appear; an empty page means not yet, not broken. Pass a target to read any space without --space.
EXAMPLES
Recent requests for the linked space.
$ sf logs
Keep pulling what your handlers log as it lands.
$ sf logs runtime --follow
What space `docs` logged from its own code.
$ sf logs docs runtime
Requests served for a space by URL.
$ sf logs https://spacefast.com access
Everything one request logged.
$ sf logs runtime --request-id req_9f21
Only what the `checkout` handler logged.
$ sf logs runtime --handler checkout
Stream one JSON object per line, for piping into jq.
$ sf logs runtime --follow --json
See code: src/commands/logs.ts
sf map
Print the machine-readable command map.
USAGE
$ sf map [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--paths]
FLAGS
--paths Print only canonical command invocations.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Print the machine-readable command map.
List the flat CLI command surface for agents and other programmatic callers.
EXAMPLES
Return canonical commands, aliases, and invocations as JSON.
$ sf map --json
Print one canonical command invocation per line.
$ sf map --paths
See code: src/commands/map.ts
sf mcp
Run the Spacefast MCP server.
USAGE
$ sf mcp [--api-url <value>] [--profile <value>] [--token <value>] [--workspace-root <value>]
FLAGS
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL for MCP tool calls.
--token=<value> [env: SPACEFAST_TOKEN] Spacefast API token for MCP tool calls.
--workspace-root=<value> [env: SPACEFAST_MCP_WORKSPACE_ROOT] Root allowed for On-Device MCP path publishing.
GLOBAL FLAGS
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
DESCRIPTION
Run the Spacefast MCP server.
Run the Spacefast On-Device MCP server over stdio for MCP clients.
EXAMPLES
$ sf mcp
See code: src/commands/mcp.ts
sf mcp install
Install MCP client config.
USAGE
$ sf mcp install [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--agent
auto|all|generic|claude-code|claude-app|claude-desktop|cursor|codex|chatgpt|vscode|github-copilot|devin-desktop|devi
n-cloud|zed|gemini-cli|opencode|amp|warp|factory-droid|cline|continue|raycast|poke|pi|indent|hermes|openclaw|app.dev
in.ai|chatgpt-work|claude|claude-code-cli|claude.ai|clawhub|copilot|devin|droid|earendil|factory|gemini|pi.dev|winds
urf...] [--local | --remote | --oauth]
FLAGS
--agent=<option>... Agent/client to configure. Repeat to configure more than one.
<options: auto|all|generic|claude-code|claude-app|claude-desktop|cursor|codex|chatgpt|vscode|gith
ub-copilot|devin-desktop|devin-cloud|zed|gemini-cli|opencode|amp|warp|factory-droid|cline|continu
e|raycast|poke|pi|indent|hermes|openclaw|app.devin.ai|chatgpt-work|claude|claude-code-cli|claude.
ai|clawhub|copilot|devin|droid|earendil|factory|gemini|pi.dev|windsurf>
--local Use checkout-aware local stdio MCP instead of the hosted proxy.
--oauth With --remote, connect directly and let the editor handle OAuth.
--remote Use hosted MCP through `sf mcp proxy` and the current CLI login.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Install MCP client config.
Install Spacefast MCP config into detected or selected coding agents.
EXAMPLES
Install hosted MCP through the signed-in Spacefast proxy.
$ sf mcp install --agent claude-code
Install direct hosted MCP with editor-managed OAuth for Cursor.
$ sf mcp install --agent cursor --remote --oauth
See code: src/commands/mcp/install.ts
sf mcp proxy
Run the authenticated remote MCP proxy.
USAGE
$ sf mcp proxy [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--endpoint <value>]
[--allow-credential-origin <value>...]
FLAGS
--allow-credential-origin=<value>... [env: SPACEFAST_MCP_ALLOW_CREDENTIAL_ORIGIN] Send your Spacefast login to this
MCP origin even though it was not issued for it. Repeatable.
--endpoint=<value> [env: SPACEFAST_MCP_URL] Remote MCP endpoint. HTTPS is required except on
loopback.
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] API key for non-interactive auth.
DESCRIPTION
Run the authenticated remote MCP proxy.
Proxy remote Spacefast MCP over stdio using the current CLI login.
EXAMPLES
Run the authenticated remote MCP proxy.
$ sf mcp proxy
See code: src/commands/mcp/proxy.ts
sf open [TARGET]
Open a private Space.
USAGE
$ sf open [TARGET] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--path <value>] [--show-secret]
ARGUMENTS
[TARGET] Space ID, slug, live URL, Version 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
OPEN FLAGS
--path=<value> [default: /] Clean route to open after the exchange.
--show-secret Print the temporary handoff URL instead of opening it.
DESCRIPTION
Open a private Space.
Mint a temporary author handoff and open the private Space. This never creates a recipient Link.
EXAMPLES
Open the linked private Space.
$ sf open
Open Space `docs` privately.
$ sf open docs
See code: src/commands/open.ts
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
SPACE SELECTION FLAGS
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key 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
See code: src/commands/operations.ts
sf pages
Manage Pages templates.
USAGE
$ sf pages [--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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Manage Pages templates.
Pull, validate, and preview Spacefast-authored pages.
EXAMPLES
Manage Pages templates.
$ sf pages
See code: src/commands/pages.ts
sf pages pull [TARGET]
Own a default page template.
USAGE
$ sf pages pull [TARGET] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
ARGUMENTS
[TARGET] Page id, layout, or all.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Own a default page template.
Copy Spacefast's readable default page HTML into your project.
EXAMPLES
Own a default page template.
$ sf pages pull [target]
See code: src/commands/pages/pull.ts
sf pages validate
Validate local Pages templates.
USAGE
$ sf pages validate [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-d <value>]
FLAGS
-d, --dir=<value> [default: .] Project directory.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Validate local Pages templates.
Run the same structural Pages checks used by publish.
EXAMPLES
Validate local Pages templates.
$ sf pages validate
See code: src/commands/pages/validate.ts
sf plugins
Install the Spacefast agent plugin.
USAGE
$ sf plugins [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--agent
auto|all|generic|claude-code|claude-app|claude-desktop|cursor|codex|chatgpt|vscode|github-copilot|devin-desktop|devi
n-cloud|zed|gemini-cli|opencode|amp|warp|factory-droid|cline|continue|raycast|poke|pi|indent|hermes|openclaw|app.dev
in.ai|chatgpt-work|claude|claude-code-cli|claude.ai|clawhub|copilot|devin|droid|earendil|factory|gemini|pi.dev|winds
urf] [--dry-run]
FLAGS
--agent=<option> [default: claude-code] Plugin-capable agent to configure.
<options: auto|all|generic|claude-code|claude-app|claude-desktop|cursor|codex|chatgpt|vscode|github-
copilot|devin-desktop|devin-cloud|zed|gemini-cli|opencode|amp|warp|factory-droid|cline|continue|rayc
ast|poke|pi|indent|hermes|openclaw|app.devin.ai|chatgpt-work|claude|claude-code-cli|claude.ai|clawhu
b|copilot|devin|droid|earendil|factory|gemini|pi.dev|windsurf>
--dry-run Print the pinned installer command without changing agent configuration.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Install the Spacefast agent plugin.
Install the Spacefast plugin lane for agents that support plugins.
EXAMPLES
Install the first-party Spacefast plugin for Cursor.
$ sf plugins --agent cursor
Install the Spacefast plugin for Claude Code.
$ sf plugins --agent claude-code
Print the pinned installer command without running it.
$ sf plugins --agent codex --dry-run
See code: src/commands/plugins.ts
sf profiles
List 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key 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.
EXAMPLES
List configured provider profiles.
$ sf profiles
See code: src/commands/profiles.ts
sf profiles rm NAME
Remove 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Remove a provider profile.
Delete a named provider profile and its stored credential.
ALIASES
$ sf profiles remove
$ sf profiles delete
EXAMPLES
Delete the staging provider profile.
$ sf profiles rm staging
See code: src/commands/profiles/rm.ts
sf profiles set NAME
Create 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> API key bound to this profile. Pass "" to clear a saved key.
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 key.
EXAMPLES
$ sf profiles set acme --api-url https://api.acme-host.example --token st_...
$ sf profiles set acme --token ""
See code: src/commands/profiles/set.ts
sf profiles use NAME
Select 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Select the active provider profile.
Select the profile used when no --profile flag or env is set.
EXAMPLES
Select the staging profile as the default.
$ sf profiles use staging
See code: src/commands/profiles/use.ts
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.
--json Format output as json.
--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 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] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
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
See code: src/commands/promote.ts
sf publish [DIR]
Publish files or built projects 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] [--access private|team|public] [--mode website|files] [--target
production|preview] [--dry-run]
[--config-only] [--wait] [--wait-timeout <value>] [--stream] [--show-secret] [--build] [--remote] [--prebuilt]
[--root-directory <value>] [--install-directory <value>] [--install-command <value>] [--build-command <value>]
[--output-directory <value>] [--env-file <value>...] [--ignored-build-command <value>] [--source-include <value>...]
[--skip-install] [--skip-build] [--publish-mode additive|snapshot] [--immutable-asset-prefix <value>...]
[--allow-unsupported-platform-features] [--auto-finalize]
ARGUMENTS
[DIR] File, directory, project, or .zip/.tar.gz archive to publish. Defaults to the current directory.
VERSION SOURCE FLAGS
-m, --message=<value> [env: SPACEFAST_PUBLISH_MESSAGE] Changelog entry 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.
--access=<option> Set initial root access when this publish creates a team-owned space.
<options: private|team|public>
--hostname-scope=<option> Managed hostname scope for newly created spaces.
<options: team|global>
--mode=<option> Serve the space as a website (default) or as a raw file listing. Usually set in
sf.jsonc.
<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.
--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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
MIGRATION FLAGS
--allow-unsupported-platform-features Publish even when imported platform config includes features Spacefast cannot
convert.
EXECUTION FLAGS
--[no-]auto-finalize Finalize a remote build automatically after staging its output.
--config-only Publish a config-only version that carries the prior artifact forward without building or
uploading content.
--dry-run Print the resolved publish plan without uploading files or writing state.
--[no-]stream With --json, emit a JSONL publish event stream instead of a single result.
--target=<option> Publish to production (live) or create a preview version without changing live traffic or
existing Space settings.
<options: production|preview>
--[no-]wait Wait until the target version is ready and, for production, live before returning.
--wait-timeout=<value> [default: 900] Seconds to wait for the version to become ready.
BUILD FLAGS
--build Force build mode for directories. Archives always use remote project detection.
--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 build when it exits 0.
--install-command=<value> Install command. Defaults to package-manager detection.
--install-directory=<value> Repository subdirectory to run dependency installation from.
--output-directory=<value> Build output directory relative to the app root.
--prebuilt Publish a prebuilt directory or archive without installing or building.
--remote Upload source and run the build remotely.
--root-directory=<value> Repository subdirectory that contains the app.
--skip-build Skip the build command and publish the selected directory unless --output-directory
is set.
--skip-install Skip dependency installation.
--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] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
VERSION FLAGS
--immutable-asset-prefix=<value>... Path prefix whose files are content-addressed and kept from the previous version,
so a tab loaded before this publish can still fetch its chunks. Snapshot mode
only. Repeat for multiple prefixes.
--publish-mode=<option> Replace everything in the space (snapshot, default) or add to what is already
published (additive).
<options: additive|snapshot>
OUTPUT FLAGS
--show-secret Print the access URL and claim link in JSON or non-interactive output.
DESCRIPTION
Publish files or built projects to Spacefast.
Publish a file, directory, project, or archive to Spacefast. Files and static directories deploy directly; archives
always use remote detection, which packs static content unchanged and builds detected applications. sf deploy is an
exact alias. Deploying is publishing: a deployment is a version, and the canonical nouns are version, channel, and
build.
ALIASES
$ sf deploy
EXAMPLES
Publish a file or directory directly.
$ sf publish ./dist
Build a detected project, or publish the directory directly if no build exists.
$ sf publish
Upload source and run the build remotely.
$ sf publish --remote
Publish a file archive, or build a detected project archive remotely.
$ sf publish ./site.zip
Publish an unpromoted preview without moving the live channel.
$ sf publish --target preview --json
Stream JSONL build and publish events.
$ sf publish --json --stream
See code: src/commands/publish.ts
sf redeploy [BUILD]
Retry the latest build (alias of sf builds retry).
USAGE
$ sf redeploy [BUILD] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>]
ARGUMENTS
[BUILD] Build ID (bld_...) to retry. Defaults to the space's most recent build.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Retry the latest build (alias of `sf builds retry`).
Retry a terminal build with the same input, settings, and target. Without a build id it retries the space's most
recent build. Alias of `sf builds retry`. Deploying is publishing: a deployment is a version, and the canonical nouns
are version, channel, and build.
EXAMPLES
Retry the most recent build of the linked space.
$ sf redeploy
Retry a specific terminal build.
$ sf redeploy bld_123
See code: src/commands/redeploy.ts
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.
--json Format output as json.
--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 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] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
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
See code: src/commands/rollback.ts
sf routing
Routing 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Routing utilities.
Inspect routing configuration and compute redirects/headers.
EXAMPLES
Routing utilities.
$ sf routing
See code: src/commands/routing.ts
sf routing compute
Compute 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Compute routing.
Resolve the latest version's _redirects and _headers with current variables.
EXAMPLES
Resolve the latest version's redirects and headers.
$ sf routing compute --space docs
See code: src/commands/routing/compute.ts
sf routing inspect
Inspect 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, _headers, and sf.jsonc 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Inspect local routing files.
Compile local _redirects, _headers, and sf.jsonc routing rules and optionally match URLs against the merged rules.
EXAMPLES
Compile the routing files in the current directory.
$ sf routing inspect
Match a path against the compiled local routing rules.
$ sf routing inspect --routing ./dist --url /old-path
See code: src/commands/routing/inspect.ts
sf runtime
Inspect a space's 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Inspect a space's runtime.
Inspect what a space is serving and what runs it.
EXAMPLES
Inspect a space's runtime.
$ sf runtime
See code: src/commands/runtime.ts
sf runtime status
Show what a space is serving.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Show what a space is serving.
Show what a space is serving: its live version, the URL it answers on, and what the live version deployed when it
ships code. A capsule lists tables, queries, mutations, endpoints, migration count and schema digest; a worker lists
entry, bundle digest, routes, endpoints and capabilities. All of it comes from version metadata, so it answers while
the runtime is asleep or moving.
EXAMPLES
What the linked space is serving right now.
$ sf runtime status
The same for space `docs`.
$ sf runtime status --space docs
See code: src/commands/runtime/status.ts
sf setup
Generate setup instructions.
USAGE
$ sf setup [--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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Generate setup instructions.
Generate setup instructions for agents and integrations.
EXAMPLES
Generate setup instructions.
$ sf setup
See code: src/commands/setup.ts
sf setup agent
Install Spacefast agent tooling.
USAGE
$ sf setup agent [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--agent
auto|all|generic|claude-code|claude-app|claude-desktop|cursor|codex|chatgpt|vscode|github-copilot|devin-desktop|devi
n-cloud|zed|gemini-cli|opencode|amp|warp|factory-droid|cline|continue|raycast|poke|pi|indent|hermes|openclaw|app.dev
in.ai|chatgpt-work|claude|claude-code-cli|claude.ai|clawhub|copilot|devin|droid|earendil|factory|gemini|pi.dev|winds
urf...] [-p] [--local | --remote | --oauth] [--skip-mcp] [--force] [--handoff]
FLAGS
-p, --project Install skills into this project instead of global agent directories.
-y, --yes Skip prompts, auto-detect agents, and accept local stdio MCP.
--agent=<option>... Agent/client to configure. Repeat to configure more than one.
<options: auto|all|generic|claude-code|claude-app|claude-desktop|cursor|codex|chatgpt|vscode|
github-copilot|devin-desktop|devin-cloud|zed|gemini-cli|opencode|amp|warp|factory-droid|cline
|continue|raycast|poke|pi|indent|hermes|openclaw|app.devin.ai|chatgpt-work|claude|claude-code
-cli|claude.ai|clawhub|copilot|devin|droid|earendil|factory|gemini|pi.dev|windsurf>
--force Overwrite locally modified or unverified Spacefast skill files.
--handoff Redeem a one-use agent handoff link from the dashboard before generating setup. The link is
read from stdin.
--local Use checkout-aware local stdio MCP instead of the hosted proxy.
--oauth With --remote, connect directly and let the editor handle OAuth.
--remote Use hosted MCP through `sf mcp proxy` and the current CLI login.
--skip-mcp Install skills without configuring MCP.
GLOBAL FLAGS
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Install Spacefast agent tooling.
Detect agent clients and configure Spacefast skills plus MCP in one idempotent flow.
EXAMPLES
Configure detected agents with hosted MCP through the CLI login.
$ sf setup agent -y
Configure Cursor with direct hosted MCP and editor OAuth.
$ sf setup agent -y --agent cursor --remote --oauth
See code: src/commands/setup/agent.ts
sf share
Manage Space Grants.
USAGE
$ sf share [--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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Manage Space Grants.
List every active Grant. Use `sf share grant`, `link`, `password`, `token`, or `oidc` to add access.
EXAMPLES
Manage Space Grants.
$ sf share
See code: src/commands/share.ts
sf share check
Explain effective Grant access.
USAGE
$ sf share check [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--path <value>] [--as public|team|person|link|password|machine|external]
[--person <value>] [--link <value>] [--password <value>] [--machine <value>] [--issuer <value>] [--subject <value>]
[--verified-email] [--ip <value>] [--target live|version|branch] [--target-id <value>]
FLAGS
--as=<option> [default: public] Audience to simulate.
<options: public|team|person|link|password|machine|external>
--ip=<value> IP address to evaluate against network constraints.
--issuer=<value> External identity issuer when --as external.
--link=<value> Link id when --as link.
--machine=<value> Machine credential id when --as machine.
--password=<value> Password credential id when --as password.
--path=<value> [default: /] Canonical route to check.
--person=<value> Person id when --as person.
--subject=<value> External identity subject when --as external.
--target=<option> [default: live] Published target kind.
<options: live|version|branch>
--target-id=<value> Version id or branch name.
--verified-email Simulate a principal with a verified email.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Explain effective Grant access.
Explain the exact additive Grants and capabilities matching one route, audience, and target.
EXAMPLES
Explain effective Grant access.
$ sf share check
See code: src/commands/share/check.ts
sf share grant
Create a Space Grant.
USAGE
$ sf share grant --to public|team --role viewer|commenter|editor|manager --path <value>... [--json] [--api-url
<value>] [--profile <value>] [--token <value>] [-y] [--claim-token <value>] [-o <value>] [--space <value>] [--wait]
[--exclude <value>...] [--target <value>] [--name <value>] [--expires <value>] [--network <value>...] [--country
<value>...] [--exclude-country <value>...] [--exclude-user-agent <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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
CONSTRAINTS FLAGS
--country=<value>... [default: ] Allowed ISO country code. Repeatable.
--exclude-country=<value>... [default: ] Blocked ISO country code. Repeatable.
--exclude-user-agent=<value>... [default: ] Block user agents containing this text. Repeatable.
--network=<value>... [default: ] Allowed IP address or CIDR. Repeatable.
GRANT FLAGS
--exclude=<value>... [default: ] Excluded route pattern local to this Grant. Repeatable.
--expires=<value> Expire after a duration such as 7d or 30m.
--name=<value> Human-readable Grant name.
--path=<value>... (required) Included route pattern. Repeat for disjoint paths.
--role=<option> (required) Role: viewer, commenter, editor, or manager.
<options: viewer|commenter|editor|manager>
--target=<value> [default: live] live, all-versions, version:<id>, or branch:<name>.
--to=<option> (required) Audience: public or team.
<options: public|team>
EXECUTION FLAGS
--[no-]wait Wait until queued work finishes before returning.
DESCRIPTION
Create a Space Grant.
Create one additive Grant. Credential-backed audiences use `sf share link`, `password`, `token`, or `oidc` so their
proof and Grant are created together.
EXAMPLES
Let the owning team view the docs subtree.
$ sf share grant --to team --role viewer --path '/docs/**'
Publish a review subtree with anonymous Comments.
$ sf share grant --to public --role commenter --path '/proposal/**' --exclude '/proposal/internal/**'
Make every immutable Version public.
$ sf share grant --to public --role viewer --path '/**' --target all-versions
See code: src/commands/share/grant.ts
sf share grant edit ID
Edit a direct managed Grant.
USAGE
$ sf share grant edit ID [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--wait] [--name <value>] [--role viewer|commenter|editor|manager]
[--exclude <value>... --path <value>...] [--target <value>] [--expires <value> | --no-expiry] [--network <value>...
| --no-network] [--country <value>... | ] [--exclude-country <value>... | ] [--exclude-user-agent <value>... | ]
ARGUMENTS
ID Managed Grant id.
FLAGS
--exclude=<value>... Excluded route pattern for the replacement path set. Repeatable.
--expires=<value> New lifetime from now (e.g. 30m, 24h, 7d).
--name=<value> New human-readable Grant name.
--no-expiry Remove the Grant expiry.
--path=<value>... Replace included route patterns. Repeat for disjoint paths.
--role=<option> Replace the role: viewer, commenter, editor, or manager.
<options: viewer|commenter|editor|manager>
--target=<value> Replace the target: live, all-versions, version:<id>, or branch:<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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
CONSTRAINTS FLAGS
--country=<value>... Replace allowed ISO country codes. Repeatable.
--exclude-country=<value>... Replace blocked ISO country codes. Repeatable.
--exclude-user-agent=<value>... Replace blocked user-agent substrings. Repeatable.
--network=<value>... Replace allowed IP addresses or CIDRs. Repeatable.
--no-network Remove every network constraint from this Grant.
EXECUTION FLAGS
--[no-]wait Wait until queued work finishes before returning.
DESCRIPTION
Edit a direct managed Grant.
Replace editable dimensions of a direct managed Grant while preserving its stable id.
EXAMPLES
Edit a direct managed Grant.
$ sf share grant edit <id>
See code: src/commands/share/grant/edit.ts
sf share identity
Manage external identity access.
USAGE
$ sf share identity [--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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Manage external identity access.
Connect OIDC or a white-label signer, then grant external subjects precise capabilities and paths.
EXAMPLES
Manage external identity access.
$ sf share identity
See code: src/commands/share/identity.ts
sf share identity create
Create an identity connection.
USAGE
$ sf share identity create --type oidc|signer --name <value> --issuer <value> [--json] [--api-url <value>] [--profile
<value>] [--token <value>] [-y] [-o <value>] [--client-id <value>] [--client-secret <value>] [--authorize-url
<value>] [--key <value>...]
FLAGS
--authorize-url=<value>
--client-id=<value>
--client-secret=<value>
--issuer=<value> (required)
--key=<value>... [default: ] Signer key in "kid:base64url-public-key" form. Repeat during rotation.
--name=<value> (required)
--type=<option> (required)
<options: oidc|signer>
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Create an identity connection.
Create an OIDC connection or a white-label Ed25519 signer connection for a Team.
EXAMPLES
Create an identity connection.
$ sf share identity create --type <type> --name <name> --issuer <issuer>
See code: src/commands/share/identity/create.ts
sf share identity grant
Create an external identity Grant.
USAGE
$ sf share identity grant --connection <value> --subject <value> --name <value> [--json] [--api-url <value>] [--profile
<value>] [--token <value>] [-y] [--claim-token <value>] [-o <value>] [--space <value>] [--role
viewer|commenter|editor|manager] [--path <value>...] [--except <value>...] [--target <value>] [--not-before <value>]
[--expires <value>] [--max-uses <value>] [--network <value>...] [--country <value>...] [--exclude-country
<value>...] [--exclude-user-agent <value>...] [--require-verified-email]
FLAGS
--connection=<value> (required)
--except=<value>... [default: ]
--name=<value> (required)
--path=<value>... [default: /**]
--role=<option> [default: viewer]
<options: viewer|commenter|editor|manager>
--subject=<value> (required)
--target=<value> [default: live] live, all-versions, version:<id>, or branch:<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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
CONSTRAINTS FLAGS
--country=<value>... [default: ] Allowed ISO country code. Repeatable.
--exclude-country=<value>... [default: ] Blocked ISO country code. Repeatable.
--exclude-user-agent=<value>... [default: ] Block user agents containing this text. Repeatable.
--expires=<value> Expire after a duration such as 7d or 30m.
--max-uses=<value> Maximum successful admissions before the Grant stops working.
--network=<value>... [default: ] Allowed IP address or CIDR. Repeatable.
--not-before=<value> Do not admit this Grant before this ISO date-time.
--require-verified-email Require email verification for this credential.
DESCRIPTION
Create an external identity Grant.
Grant one externally proven subject precise capabilities and paths on a Space.
EXAMPLES
Create an external identity Grant.
$ sf share identity grant --connection <connection> --subject <subject> --name <name>
See code: src/commands/share/identity/grant.ts
sf share identity ls
List identity connections.
USAGE
$ sf share identity 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
List identity connections.
List Team OIDC and white-label signer connections.
ALIASES
$ sf share identity list
EXAMPLES
List identity connections.
$ sf share identity ls
See code: src/commands/share/identity/ls.ts
sf share identity revoke CONNECTION
Revoke an identity connection.
USAGE
$ sf share identity revoke CONNECTION [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-o
<value>]
ARGUMENTS
CONNECTION Identity connection 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Revoke an identity connection.
Revoke an identity connection, its external Grants, and admitted sessions.
EXAMPLES
Revoke an identity connection.
$ sf share identity revoke <connection>
See code: src/commands/share/identity/revoke.ts
sf share identity update CONNECTION
Update or rotate an identity connection.
USAGE
$ sf share identity update CONNECTION [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-o
<value>] [--name <value>] [--client-id <value>] [--client-secret <value>] [--authorize-url <value>] [--key
<value>...] [--session-ttl <value>]
ARGUMENTS
CONNECTION Identity connection id.
FLAGS
--authorize-url=<value>
--client-id=<value>
--client-secret=<value>
--key=<value>... Complete replacement signer key set in "kid:base64url-public-key" form. Repeat to overlap old
and new keys.
--name=<value>
--session-ttl=<value> Admitted session lifetime, for example 30m or 8h.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Update or rotate an identity connection.
Rotate OIDC secrets or signer keys and update connection settings without changing external Grants.
EXAMPLES
Update or rotate an identity connection.
$ sf share identity update <connection>
See code: src/commands/share/identity/update.ts
sf share link
Manage Links.
USAGE
$ sf share link [--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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Manage Links.
Create, list, edit, copy, and revoke named Links. Each Link owns one Grant with paths, exclusions, capabilities, and a
serving target.
EXAMPLES
Manage Links.
$ sf share link
See code: src/commands/share/link.ts
sf share link copy ID
Copy a Link.
USAGE
$ sf share link copy ID [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--show-secret]
ARGUMENTS
ID Share link id (see `sf share link ls`).
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
LINK FLAGS
--show-secret Print the share URL even when output is JSON or non-interactive.
DESCRIPTION
Copy a Link.
Print a Link's durable share URL.
EXAMPLES
Print the Link's share URL.
$ sf share link copy lnk_123
See code: src/commands/share/link/copy.ts
sf share link create
Create a Link.
USAGE
$ sf share link create --name <value> [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>] [--landing <value>] [--path <value>...] [--exclude
<value>...] [--role viewer|commenter] [--target <value>] [--not-before <value>] [--expires <value>] [--max-uses
<value>] [--require-verified-email] [--network <value>...] [--country <value>...] [--exclude-country <value>...]
[--exclude-user-agent <value>...] [--show-secret]
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
CONSTRAINTS FLAGS
--country=<value>... [default: ] Allowed ISO country code. Repeatable.
--exclude-country=<value>... [default: ] Blocked ISO country code. Repeatable.
--exclude-user-agent=<value>... [default: ] Block user agents containing this text. Repeatable.
--expires=<value> How long the link lasts (e.g. 30m, 24h, 7d). Omit for no expiry.
--max-uses=<value> Maximum successful opens before the Link stops working.
--network=<value>... [default: ] Allowed IP address or CIDR. Repeatable.
--not-before=<value> Do not admit this Link before this ISO date-time.
--require-verified-email Admit only visitors whose session has a verified email.
LINK FLAGS
--exclude=<value>... [default: ] Excluded route pattern local to this Link. Repeatable.
--landing=<value> [default: /] Clean route opened after exchange.
--name=<value> (required) Human name shown in the Links list.
--path=<value>... [default: /**] Included route pattern. Repeat for disjoint paths.
--role=<option> [default: commenter] Role: viewer or commenter. Defaults to commenter.
<options: viewer|commenter>
--show-secret Print the share URL even when output is JSON or non-interactive.
--target=<value> [default: live] live, all-versions, version:<id>, or branch:<name>.
DESCRIPTION
Create a Link.
Create a named Link backed by one Grant. Links can View or Comment on multiple path patterns.
EXAMPLES
Create a client Link that can comment on two path groups except internal docs.
$ sf share link create --landing /docs --path "/docs/**" --path "/assets/**" --exclude "/docs/internal/**" \
--role commenter --name "Client review" --expires 7d
See code: src/commands/share/link/create.ts
sf share link edit ID
Edit Link metadata.
USAGE
$ sf share link edit ID [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--name <value>] [--landing <value>] [--exclude <value>... --path
<value>...] [--role viewer|commenter] [--target <value>] [--not-before <value> | --no-not-before] [--expires <value>
| --no-expiry] [--max-uses <value> | --no-max-uses] [--require-verified-email | --allow-unverified-email] [--network
<value>... | --no-network] [--country <value>... | ] [--exclude-country <value>... | ] [--exclude-user-agent
<value>... | ]
ARGUMENTS
ID Link 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
CONSTRAINTS FLAGS
--allow-unverified-email Remove the verified-email requirement.
--country=<value>... Replace allowed ISO country codes. Repeatable.
--exclude-country=<value>... Replace blocked ISO country codes. Repeatable.
--exclude-user-agent=<value>... Replace blocked user-agent substrings. Repeatable.
--expires=<value> New lifetime from now (e.g. 30m, 24h, 7d).
--max-uses=<value> Replace the maximum successful opens.
--network=<value>... Replace allowed IP addresses or CIDRs. Repeatable.
--no-expiry Remove the Link expiry.
--no-max-uses Remove the open limit.
--no-network Remove network restrictions.
--no-not-before Remove the earliest admission time.
--not-before=<value> Replace the earliest admission time with this ISO date-time.
--require-verified-email Require a verified email.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
LINK FLAGS
--exclude=<value>... Excluded route pattern for the replacement path set. Repeatable.
--landing=<value> New clean landing path.
--name=<value> New Link name.
--path=<value>... Replace included route patterns. Repeat for disjoint paths.
--role=<option> Replace the role: viewer or commenter.
<options: viewer|commenter>
--target=<value> Replace the target: live, all-versions, version:<id>, or branch:<name>.
DESCRIPTION
Edit Link metadata.
Replace a Link's metadata or Grant dimensions without rotating its stable URL.
EXAMPLES
Edit Link metadata.
$ sf share link edit <id>
See code: src/commands/share/link/edit.ts
sf share link ls
List Links.
USAGE
$ sf share link 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
List Links.
List named Links with Grant paths, capabilities, target, expiry, and lifecycle. List reads never carry credentials.
ALIASES
$ sf share link list
EXAMPLES
List share links for the docs space.
$ sf share link ls --space docs
See code: src/commands/share/link/ls.ts
sf share link revoke ID
Revoke a Link.
USAGE
$ sf share link revoke ID [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>]
ARGUMENTS
ID Share link id (see `sf share link ls`).
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Revoke a Link.
Revoke a share link. The grant drops from the compiled rule set in the same write, so every outstanding URL stops
working on the next request.
EXAMPLES
Revoke a share link.
$ sf share link revoke lnk_123
See code: src/commands/share/link/revoke.ts
sf share list
List Space Grants.
USAGE
$ sf share list [--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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
List Space Grants.
List every active Grant, including config, team, Person, Link, password, machine, and external identity access.
ALIASES
$ sf share ls
EXAMPLES
List Space Grants.
$ sf share list
See code: src/commands/share/list.ts
sf share password
Manage password access.
USAGE
$ sf share password [--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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Manage password access.
Create, list, rotate, and revoke named password Grants. Passwords never live in sf.jsonc.
EXAMPLES
Manage password access.
$ sf share password
See code: src/commands/share/password.ts
sf share password create
Create password access.
USAGE
$ sf share password create --name <value> --path <value>... [--json] [--api-url <value>] [--profile <value>] [--token
<value>] [-y] [--claim-token <value>] [-o <value>] [--space <value>] [--password <value>] [--password-from-stdin]
[--role viewer|commenter] [--exclude <value>...] [--target <value>] [--not-before <value>] [--expires <value>]
[--max-uses <value>] [--network <value>...] [--country <value>...] [--exclude-country <value>...]
[--exclude-user-agent <value>...] [--require-verified-email]
FLAGS
--exclude=<value>... [default: ] Local exclusion pattern.
--name=<value> (required) Human-readable password name.
--password=<value> [env: SPACEFAST_SHARE_PASSWORD] Password, or set SPACEFAST_SHARE_PASSWORD.
--password-from-stdin Read the password from standard input.
--path=<value>... (required) Included route pattern.
--role=<option> [default: commenter] Role granted to password holders.
<options: viewer|commenter>
--target=<value> [default: live] Published target selector.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
CONSTRAINTS FLAGS
--country=<value>... [default: ] Allowed ISO country code. Repeatable.
--exclude-country=<value>... [default: ] Blocked ISO country code. Repeatable.
--exclude-user-agent=<value>... [default: ] Block user agents containing this text. Repeatable.
--expires=<value> Expire after a duration such as 7d or 30m.
--max-uses=<value> Maximum successful admissions before the Grant stops working.
--network=<value>... [default: ] Allowed IP address or CIDR. Repeatable.
--not-before=<value> Do not admit this Grant before this ISO date-time.
--require-verified-email Require email verification for this credential.
DESCRIPTION
Create password access.
Create a named scoped password Grant. The verifier is Argon2id and rotation fences existing sessions.
EXAMPLES
Create password access.
$ sf share password create --name <name> --path <path>
See code: src/commands/share/password/create.ts
sf share password ls
List password access.
USAGE
$ sf share password 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
List password access.
List password proof metadata and the Grants they admit.
ALIASES
$ sf share password list
EXAMPLES
List password access.
$ sf share password ls
See code: src/commands/share/password/ls.ts
sf share password revoke ID
Revoke password access.
USAGE
$ sf share password revoke ID [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>]
ARGUMENTS
ID Password credential 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Revoke password access.
Revoke password access and its canonical Grant.
EXAMPLES
Revoke password access.
$ sf share password revoke <id>
See code: src/commands/share/password/revoke.ts
sf share password rotate ID
Rotate a password.
USAGE
$ sf share password rotate ID [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--password <value>] [--password-from-stdin]
ARGUMENTS
ID Password credential id.
FLAGS
--password=<value> [env: SPACEFAST_SHARE_PASSWORD] New password, or set SPACEFAST_SHARE_PASSWORD.
--password-from-stdin Read the new password from standard input.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Rotate a password.
Replace a password and immediately fence sessions using the old one.
EXAMPLES
Rotate a password.
$ sf share password rotate <id>
See code: src/commands/share/password/rotate.ts
sf share people
Manage People.
USAGE
$ sf share people [--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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Manage People.
Invite, list, resend, edit, and remove People. A Person can hold roles on multiple route subtrees.
EXAMPLES
Manage People.
$ sf share people
See code: src/commands/share/people.ts
sf share people edit PERSON
Edit a Person's scoped roles.
USAGE
$ sf share people edit PERSON --grant <value>... [--json] [--api-url <value>] [--profile <value>] [--token <value>]
[-y] [--claim-token <value>] [-o <value>] [--space <value>] [--target <value>]
ARGUMENTS
PERSON Person id or email address.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
PEOPLE FLAGS
--grant=<value>... (required) Scoped role in <path>=<role> form. Repeat to replace the full grant set.
--target=<value> [default: live] live, all-versions, version:<id>, or branch:<name>.
DESCRIPTION
Edit a Person's scoped roles.
Replace a Person's scoped roles atomically. Repeat --grant for every route subtree they should retain.
EXAMPLES
Keep root viewing and grant editing under /docs.
$ sf share people edit person@example.com --grant /=viewer --grant /docs=editor
See code: src/commands/share/people/edit.ts
sf share people invite EMAIL
Invite a Person.
USAGE
$ sf share people invite EMAIL [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--role viewer|commenter|editor|manager] [--scope <value>...] [--target
<value>]
ARGUMENTS
EMAIL Email address to invite.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
PEOPLE FLAGS
--role=<option> [default: viewer] Role granted on every supplied scope.
<options: viewer|commenter|editor|manager>
--scope=<value>... [default: /] Canonical route subtree. Repeat for multiple scopes.
--target=<value> [default: live] live, all-versions, version:<id>, or branch:<name>.
DESCRIPTION
Invite a Person.
Invite one Person without requiring an account. Repeat --scope to grant the same role on multiple route subtrees.
EXAMPLES
Invite a commenter to two route subtrees.
$ sf share people invite person@example.com --role commenter --scope /docs --scope /assets
Invite someone to one immutable version instead of the live space.
$ sf share people invite client@example.com --role viewer --target version:ver_123
See code: src/commands/share/people/invite.ts
sf share people ls
List People.
USAGE
$ sf share people 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
List People.
List People and every scoped role they hold.
ALIASES
$ sf share people list
EXAMPLES
List People.
$ sf share people ls
See code: src/commands/share/people/ls.ts
sf share people remove PERSON
Remove a Person.
USAGE
$ sf share people remove PERSON [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>]
ARGUMENTS
PERSON Person id or email (see `sf share people ls`).
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Remove a Person.
Remove a Person and all of their scoped grants.
EXAMPLES
Remove a Person.
$ sf share people remove <person>
See code: src/commands/share/people/remove.ts
sf share people resend PERSON
Resend a Person invitation.
USAGE
$ sf share people resend PERSON [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>]
ARGUMENTS
PERSON Person id or email.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Resend a Person invitation.
Replace a pending Person invitation and send a fresh accountless acceptance email.
EXAMPLES
Resend a Person invitation.
$ sf share people resend <person>
See code: src/commands/share/people/resend.ts
sf share request
Manage access requests.
USAGE
$ sf share request [--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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Manage access requests.
List, approve, and deny inbox-verified access requests.
EXAMPLES
Manage access requests.
$ sf share request
See code: src/commands/share/request.ts
sf share request approve ID
Approve an access request.
USAGE
$ sf share request approve ID [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--role viewer|commenter|editor|manager] [--scope <value>]
ARGUMENTS
ID Access 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
APPROVE FLAGS
--role=<option> Approved role. Defaults to the requested role.
<options: viewer|commenter|editor|manager>
--scope=<value> Approved route subtree. Defaults to the requested scope.
DESCRIPTION
Approve an access request.
Approve an access request into the canonical People list. Override the requested role or route scopes when needed.
EXAMPLES
Approve an access request.
$ sf share request approve <id>
See code: src/commands/share/request/approve.ts
sf share request deny ID
Deny an access request.
USAGE
$ sf share request deny ID [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>]
ARGUMENTS
ID Access 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Deny an access request.
Deny a pending access request.
EXAMPLES
Deny an access request.
$ sf share request deny <id>
See code: src/commands/share/request/deny.ts
sf share request ls
List access requests.
USAGE
$ sf share request 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
List access requests.
List pending access requests with requested role and route scope.
ALIASES
$ sf share request list
EXAMPLES
List access requests.
$ sf share request ls
See code: src/commands/share/request/ls.ts
sf share revoke ID
Revoke a Space Grant.
USAGE
$ sf share revoke ID [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--wait]
ARGUMENTS
ID Grant id (see `sf share list`).
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
EXECUTION FLAGS
--[no-]wait Wait until queued work finishes before returning.
DESCRIPTION
Revoke a Space Grant.
Revoke one managed Grant. Change config Grants in sf.jsonc. Credential Grants normally revoke through their credential
command.
EXAMPLES
Revoke a Space Grant.
$ sf share revoke <id>
See code: src/commands/share/revoke.ts
sf share token
Manage machine access.
USAGE
$ sf share 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Manage machine access.
Manage header-only machine credentials backed by scoped Grants.
EXAMPLES
Manage machine access.
$ sf share token
See code: src/commands/share/token.ts
sf share token create
Create a machine credential.
USAGE
$ sf share token create --name <value> --path <value>... [--json] [--api-url <value>] [--profile <value>] [--token
<value>] [-y] [--claim-token <value>] [-o <value>] [--space <value>] [--role viewer|commenter|editor|manager]
[--exclude <value>...] [--target <value>] [--not-before <value>] [--expires <value>] [--max-uses <value>] [--network
<value>...] [--country <value>...] [--exclude-country <value>...] [--exclude-user-agent <value>...] [--show-secret]
FLAGS
--exclude=<value>... [default: ] Local exclusion pattern.
--name=<value> (required) Human-readable machine name.
--path=<value>... (required) Included route pattern.
--role=<option> [default: viewer] Role granted to this machine.
<options: viewer|commenter|editor|manager>
--show-secret Print the one-time token in JSON or non-interactive output.
--target=<value> [default: live] Published target selector.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
CONSTRAINTS FLAGS
--country=<value>... [default: ] Allowed ISO country code. Repeatable.
--exclude-country=<value>... [default: ] Blocked ISO country code. Repeatable.
--exclude-user-agent=<value>... [default: ] Block user agents containing this text. Repeatable.
--expires=<value> Expire after a duration such as 7d or 30m.
--max-uses=<value> Maximum successful admissions before the Grant stops working.
--network=<value>... [default: ] Allowed IP address or CIDR. Repeatable.
--not-before=<value> Do not admit this Grant before this ISO date-time.
DESCRIPTION
Create a machine credential.
Create a named header-only machine credential and scoped Grant. The token is returned once.
EXAMPLES
Create a machine credential.
$ sf share token create --name <name> --path <path>
See code: src/commands/share/token/create.ts
sf share token ls
List machine access.
USAGE
$ sf share token 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
List machine access.
List machine credential metadata and the Grants they admit.
ALIASES
$ sf share token list
EXAMPLES
List machine access.
$ sf share token ls
See code: src/commands/share/token/ls.ts
sf share token revoke ID
Revoke machine access.
USAGE
$ sf share token revoke ID [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>]
ARGUMENTS
ID Machine credential 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Revoke machine access.
Revoke a machine credential and its canonical Grant.
EXAMPLES
Revoke machine access.
$ sf share token revoke <id>
See code: src/commands/share/token/revoke.ts
sf share token rotate ID
Rotate a machine credential.
USAGE
$ sf share token rotate ID [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--show-secret]
ARGUMENTS
ID Machine credential id.
FLAGS
--show-secret Print the one-time token in JSON or non-interactive output.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Rotate a machine credential.
Rotate a machine credential, fence the old token, and return the replacement once.
EXAMPLES
Rotate a machine credential.
$ sf share token rotate <id>
See code: src/commands/share/token/rotate.ts
sf skills
Install or update Spacefast agent skills.
USAGE
$ sf skills [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--agent
auto|all|generic|claude-code|claude-app|claude-desktop|cursor|codex|chatgpt|vscode|github-copilot|devin-desktop|devi
n-cloud|zed|gemini-cli|opencode|amp|warp|factory-droid|cline|continue|raycast|poke|pi|indent|hermes|openclaw|app.dev
in.ai|chatgpt-work|claude|claude-code-cli|claude.ai|clawhub|copilot|devin|droid|earendil|factory|gemini|pi.dev|winds
urf...] [-p] [-l] [--force]
FLAGS
-l, --list List bundled skill files without installing.
-p, --project Install into this project instead of the agent's global skills directory.
--agent=<option>... Agent to install for. `auto` configures detected agents plus .agents/skills.
<options: auto|all|generic|claude-code|claude-app|claude-desktop|cursor|codex|chatgpt|vscode|
github-copilot|devin-desktop|devin-cloud|zed|gemini-cli|opencode|amp|warp|factory-droid|cline
|continue|raycast|poke|pi|indent|hermes|openclaw|app.devin.ai|chatgpt-work|claude|claude-code
-cli|claude.ai|clawhub|copilot|devin|droid|earendil|factory|gemini|pi.dev|windsurf>
--force Overwrite locally modified or unverified Spacefast skill files.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Install or update Spacefast agent skills.
Install or update the Spacefast agent skill bundled with this CLI.
ALIASES
$ sf skills install
EXAMPLES
Install or update the Spacefast skill for detected agents.
$ sf skills
Install or update the Spacefast skill for Codex.
$ sf skills --agent codex
Install the Spacefast skill to every supported agent.
$ sf skills --agent all
See code: src/commands/skills.ts
sf skills remove
Remove Spacefast agent skills.
USAGE
$ sf skills remove [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--agent
auto|all|generic|claude-code|claude-app|claude-desktop|cursor|codex|chatgpt|vscode|github-copilot|devin-desktop|devi
n-cloud|zed|gemini-cli|opencode|amp|warp|factory-droid|cline|continue|raycast|poke|pi|indent|hermes|openclaw|app.dev
in.ai|chatgpt-work|claude|claude-code-cli|claude.ai|clawhub|copilot|devin|droid|earendil|factory|gemini|pi.dev|winds
urf...] [-p] [--force]
FLAGS
-p, --project Remove project-local skills instead of global skills.
--agent=<option>... Agent to remove from. Repeat to remove from more than one.
<options: auto|all|generic|claude-code|claude-app|claude-desktop|cursor|codex|chatgpt|vscode|
github-copilot|devin-desktop|devin-cloud|zed|gemini-cli|opencode|amp|warp|factory-droid|cline
|continue|raycast|poke|pi|indent|hermes|openclaw|app.devin.ai|chatgpt-work|claude|claude-code
-cli|claude.ai|clawhub|copilot|devin|droid|earendil|factory|gemini|pi.dev|windsurf>
--force Remove locally modified or unverified Spacefast skill files.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Remove Spacefast agent skills.
Remove the Spacefast skill while preserving locally modified files unless forced.
ALIASES
$ sf skills rm
$ sf skills uninstall
EXAMPLES
Remove the global Codex installation.
$ sf skills remove --agent codex
Remove this project's Claude Code installation.
$ sf skills remove --project --agent claude-code
See code: src/commands/skills/remove.ts
sf skills status
Check Spacefast skill installation.
USAGE
$ sf skills status [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--agent
auto|all|generic|claude-code|claude-app|claude-desktop|cursor|codex|chatgpt|vscode|github-copilot|devin-desktop|devi
n-cloud|zed|gemini-cli|opencode|amp|warp|factory-droid|cline|continue|raycast|poke|pi|indent|hermes|openclaw|app.dev
in.ai|chatgpt-work|claude|claude-code-cli|claude.ai|clawhub|copilot|devin|droid|earendil|factory|gemini|pi.dev|winds
urf...] [-p]
FLAGS
-p, --project Check project-local skills instead of global skill directories.
--agent=<option>... Agent to check. `auto` checks detected agents plus .agents/skills.
<options: auto|all|generic|claude-code|claude-app|claude-desktop|cursor|codex|chatgpt|vscode|
github-copilot|devin-desktop|devin-cloud|zed|gemini-cli|opencode|amp|warp|factory-droid|cline
|continue|raycast|poke|pi|indent|hermes|openclaw|app.devin.ai|chatgpt-work|claude|claude-code
-cli|claude.ai|clawhub|copilot|devin|droid|earendil|factory|gemini|pi.dev|windsurf>
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Check Spacefast skill installation.
Check installed Spacefast skills against the revision bundled with this CLI.
ALIASES
$ sf skills doctor
EXAMPLES
Check all common global skill locations.
$ sf skills status
Check the Codex Spacefast skill location.
$ sf skills doctor --agent codex
Check this project's Claude Code skill location.
$ sf skills status --project --agent claude-code
See code: src/commands/skills/status.ts
sf spaces
Manage 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Manage spaces.
Manage Spacefast spaces.
EXAMPLES
Manage spaces.
$ sf spaces
See code: src/commands/spaces.ts
sf spaces add
Create 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] [--show-secret]
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
EXECUTION FLAGS
--[no-]save-state Write the created space to .spacefast/state.json.
OUTPUT FLAGS
--show-secret Print the access URL and claim link in JSON or non-interactive output.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Create an empty space.
Create an empty space and save it to .spacefast/state.json.
ALIASES
$ sf spaces create
EXAMPLES
$ sf spaces add --name docs
See code: src/commands/spaces/add.ts
sf spaces check NAME
Check whether a space name is available.
USAGE
$ sf spaces check NAME [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-o <value>]
ARGUMENTS
NAME Space name or slug to check.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Check whether a space name is available.
Check whether a space slug and its managed view.fast hostname are available.
EXAMPLES
Check a space name in the acme team.
$ sf spaces check my-site --team acme
See code: packages/cli/src/commands/spaces/check.ts
sf spaces claim
Claim an anonymous space.
USAGE
$ sf spaces claim [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [--keep-publishing] [--space <value>] [-o <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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--[no-]keep-publishing Keep the agent that published this space authorized to publish to it.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
EXECUTION FLAGS
--[no-]wait Wait until queued work finishes before returning.
DESCRIPTION
Claim an anonymous space.
Move a saved anonymous space into your account. Starts browser login if needed.
EXAMPLES
Claim the space saved in the current directory.
$ sf spaces claim
Claim a space into a specific team.
$ sf spaces claim --space spc_xxx --claim-token sfc_xxx --team my-team
See code: src/commands/spaces/claim.ts
sf spaces download
Download 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Download a space version.
Download files from a space version. Defaults to the latest version.
EXAMPLES
Download the latest version's files into ./out.
$ sf spaces download --space docs --output ./out
Download version v3, overwriting existing files.
$ sf spaces download --space docs --version v3 --overwrite
See code: src/commands/spaces/download.ts
sf spaces duplicate
Duplicate a space.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
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 work finishes before returning.
--wait-timeout=<value> [default: 900] Seconds to wait for the duplicate to become ready.
DESCRIPTION
Duplicate a space.
Download an existing space version and publish those files as a new space.
EXAMPLES
Duplicate the docs space into a new docs-copy space.
$ sf spaces duplicate --space docs --slug docs-copy
See code: src/commands/spaces/duplicate.ts
sf spaces get
Show 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Show a space.
Print a space's live runtime state and current version.
EXAMPLES
Show the space linked to the current directory.
$ sf spaces get
Show a specific space by slug, ID, or URL.
$ sf spaces get --space docs
See code: src/commands/spaces/get.ts
sf spaces ls
List 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 100).
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
List spaces.
List spaces accessible to the current login, optionally filtered by team.
ALIASES
$ sf spaces list
EXAMPLES
List spaces accessible to the current login.
$ sf spaces ls
List spaces for a specific team.
$ sf spaces ls --team acme
See code: src/commands/spaces/ls.ts
sf spaces rm
Delete 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
EXECUTION FLAGS
--[no-]wait Wait until queued work finishes before returning.
DESCRIPTION
Delete a space.
Queue deletion for the selected space.
ALIASES
$ sf spaces remove
$ sf spaces delete
EXAMPLES
Delete a space after confirmation.
$ sf spaces rm --space docs
Delete without the confirmation prompt.
$ sf spaces rm --space docs --yes
See code: src/commands/spaces/rm.ts
sf spaces rotate-claim
Rotate an anonymous Space's key.
USAGE
$ sf spaces rotate-claim [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [--space <value>]
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
SPACE SELECTION FLAGS
--space=<value> [env: SPACEFAST_SPACE] Space ID, live URL, domain, or slug.
DESCRIPTION
Rotate an anonymous Space's key.
Replace an anonymous space's key, live URL, and claim link without changing recipient Links.
EXAMPLES
Rotate the anonymous Space saved in the current directory.
$ sf spaces rotate-claim
See code: src/commands/spaces/rotate-claim.ts
sf spaces transfer TEAM
Transfer 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Transfer a space to another team.
Request a transfer of the selected space to another team. It applies once the target team accepts.
EXAMPLES
$ sf spaces transfer acme --space spc_123
See code: src/commands/spaces/transfer.ts
sf spaces update
Rename or update a space.
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] [--slug <value>] [-n <value>] [--viewer-description <value>] [--viewer-og-image-path <value>]
[--viewer-title <value>]
SPACE 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
IDENTITY FLAGS
--slug=<value> New space slug. Must be sent without other update flags.
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 work finishes before returning.
--wait-timeout=<value> Seconds to wait for queued work to finish before giving up.
DESCRIPTION
Rename or update a space.
Patch space identity, serving metadata, and generated viewer metadata.
EXAMPLES
Rename the space and its managed view.fast hostname.
$ sf spaces update --space docs --slug developers --wait
Change the space title.
$ sf spaces update --space docs --name "Developer docs"
Switch serving mode to files and disable SPA fallback.
$ sf spaces update --space docs --mode files --spa false
See code: src/commands/spaces/update.ts
sf status
Show CLI status.
USAGE
$ sf status [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--include-claim-url]
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
OUTPUT FLAGS
--include-claim-url Include the still-pending claim link.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Show CLI status.
Show authenticated user, default team, and the space the current directory is linked to.
EXAMPLES
Show login, default team, and the linked space.
$ sf status
Include the still-pending claim link.
$ sf status --include-claim-url
See code: src/commands/status.ts
sf storage [TARGET]
List a space's stored objects.
USAGE
$ sf storage [TARGET] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>] [--limit <value>] [--cursor <value>]
ARGUMENTS
[TARGET] Space ID, slug, live URL, or domain. Defaults to the linked space.
FLAGS
--cursor=<value> Continue from an opaque cursor returned by the last page.
--limit=<value> Maximum objects to return (default 50, 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
List a space's stored objects.
List object metadata and quota usage for files uploaded by a space's app.
EXAMPLES
List the linked space's objects.
$ sf storage
List the first ten objects in space `docs`.
$ sf storage docs --limit 10
See code: src/commands/storage.ts
sf storage ls [TARGET]
List a space's stored objects.
USAGE
$ sf storage ls [TARGET] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>] [--limit <value>] [--cursor <value>]
ARGUMENTS
[TARGET] Space ID, slug, live URL, or domain. Defaults to the linked space.
FLAGS
--cursor=<value> Continue from an opaque cursor returned by the last page.
--limit=<value> Maximum objects to return (default 50, 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
ALIASES
$ sf storage list
EXAMPLES
List a space's stored objects.
$ sf storage ls [target]
See code: src/commands/storage/ls.ts
sf storage rm [ID]
Delete a stored object.
USAGE
$ sf storage rm [ID] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>]
ARGUMENTS
[ID] Object id, for example 0123456789abcdef0123456789abcdef.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Delete a stored object.
Force-delete an app storage object as the space owner, regardless of who uploaded it.
ALIASES
$ sf storage remove
$ sf storage delete
EXAMPLES
Delete a stored object without prompting.
$ sf storage rm 0123456789abcdef0123456789abcdef --yes
See code: src/commands/storage/rm.ts
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Switch teams.
Set the default team for future CLI commands.
EXAMPLES
Set acme as the default team for future commands.
$ sf switch acme
See code: src/commands/switch.ts
sf tags
List effective tags.
USAGE
$ sf tags [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--environment <value>]
FLAGS
--environment=<value> Release environment to inspect.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
List effective tags.
Read the current released effective tags for a space.
EXAMPLES
Show the current released effective tags.
$ sf tags --space docs
Show effective tags for the production environment.
$ sf tags --space docs --environment production
See code: src/commands/tags.ts
sf tags apply FILE
Apply declarative tags.
USAGE
$ sf tags apply FILE [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--title <value>] [-m <value>] [--submit] [--release <value>]
[--expected-current-revision <value>] [--idempotency-key <value>]
ARGUMENTS
FILE spacefast.tags.json file.
FLAGS
-m, --message=<value> Draft or submission message.
--expected-current-revision=<value> Optimistic release current revision check.
--idempotency-key=<value> Idempotency key for replay-safe apply.
--release=<value> Release environment after approval policy allows.
--submit Submit after validation when policy allows.
--title=<value> Draft title.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Apply declarative tags.
Apply a declarative tag config by creating/updating a draft, validating, and optionally submitting or releasing.
EXAMPLES
Apply a declarative tag config as a draft.
$ sf tags apply spacefast.tags.json --space docs
Apply, submit, and release to production when policy allows.
$ sf tags apply spacefast.tags.json --space docs --submit --release production
See code: src/commands/tags/apply.ts
sf tags debug
Create a tag debug session.
USAGE
$ sf tags debug [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--revision <value>] [--revoke-session <value>] [--url <value>]
[--environment <value>] [--idempotency-key <value>]
FLAGS
--environment=<value> Release environment to debug.
--idempotency-key=<value> Idempotency key for replay-safe debug sessions.
--revision=<value> Tag revision ID to debug.
--revoke-session=<value> Preview/debug session ID to revoke.
--url=<value> Page URL to open in debug mode.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Create a tag debug session.
Create a signed no-store tag preview/debug session.
EXAMPLES
Create a signed tag debug session for a page.
$ sf tags debug --space docs --url https://docs.view.fast
See code: src/commands/tags/debug.ts
sf tags releases
List tag releases.
USAGE
$ sf tags releases [--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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
List tag releases.
List tag release pointers for this space.
EXAMPLES
List tag release pointers for the space.
$ sf tags releases --space docs
See code: src/commands/tags/releases.ts
sf tags releases get ENVIRONMENT
Read a tag release.
USAGE
$ sf tags releases get ENVIRONMENT [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>]
ARGUMENTS
ENVIRONMENT Release environment, for example production.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Read a tag release.
Read one tag release pointer.
EXAMPLES
Read the production tag release pointer.
$ sf tags releases get production --space docs
See code: src/commands/tags/releases/get.ts
sf tags releases rollback ENVIRONMENT REVISION
Roll back a tag release.
USAGE
$ sf tags releases rollback ENVIRONMENT REVISION [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>] [--expected-current-revision <value>] [--notes <value>]
[--idempotency-key <value>]
ARGUMENTS
ENVIRONMENT Release environment, for example production.
REVISION Prior published tag revision ID to restore.
FLAGS
--expected-current-revision=<value> Optimistic current revision check.
--idempotency-key=<value> Idempotency key for replay-safe rollback.
--notes=<value> Rollback notes.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Roll back a tag release.
Move a tag release pointer back to a prior published revision.
EXAMPLES
Roll the production tag release back to a prior revision.
$ sf tags releases rollback production tver_123 --space docs
See code: src/commands/tags/releases/rollback.ts
sf tags releases set ENVIRONMENT REVISION
Set a tag release.
USAGE
$ sf tags releases set ENVIRONMENT REVISION [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>] [--expected-current-revision <value>] [--notes <value>]
[--idempotency-key <value>]
ARGUMENTS
ENVIRONMENT Release environment, for example production.
REVISION Approved tag revision ID to release.
FLAGS
--expected-current-revision=<value> Optimistic current revision check.
--idempotency-key=<value> Idempotency key for replay-safe release.
--notes=<value> Release notes.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Set a tag release.
Point a tag release environment at an approved immutable revision.
EXAMPLES
Point the production tag release at an approved revision.
$ sf tags releases set production tver_123 --space docs
See code: src/commands/tags/releases/set.ts
sf tags revisions
List tag revisions.
USAGE
$ sf tags revisions [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--status <value>] [--cursor <value>] [--limit <value>]
FLAGS
--cursor=<value> Pagination cursor.
--limit=<value> Maximum number of revisions to return.
--status=<value> Filter by revision status.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
List tag revisions.
List draft, in-review, approved, published, and abandoned tag revisions.
EXAMPLES
List tag revisions for the space.
$ sf tags revisions --space docs
List draft tag revisions.
$ sf tags revisions --space docs --status draft
See code: src/commands/tags/revisions.ts
sf tags revisions abandon REVISION
Abandon a tag revision.
USAGE
$ sf tags revisions abandon REVISION [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>] [--idempotency-key <value>]
ARGUMENTS
REVISION Tag revision ID.
FLAGS
--idempotency-key=<value> Idempotency key for replay-safe abandon.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Abandon a tag revision.
Abandon a mutable tag revision.
EXAMPLES
$ sf tags revisions abandon tver_123 --space docs
See code: src/commands/tags/revisions/abandon.ts
sf tags revisions approve REVISION
Approve a tag revision.
USAGE
$ sf tags revisions approve REVISION [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>] [--idempotency-key <value>]
ARGUMENTS
REVISION Tag revision ID.
FLAGS
--idempotency-key=<value> Idempotency key for replay-safe approval.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Approve a tag revision.
Approve a tag revision after validation and policy gates pass.
EXAMPLES
$ sf tags revisions approve tver_123 --space docs
See code: src/commands/tags/revisions/approve.ts
sf tags revisions create
Create a tag revision.
USAGE
$ sf tags revisions create [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [--claim-token
<value>] [-o <value>] [--space <value>] [--title <value>] [-m <value>] [--base-revision <value>] [-i <value>]
[--template <value>] [--field <value>...] [--trigger <value>...] [--tag-id <value>] [--name <value>]
[--idempotency-key <value>]
FLAGS
-i, --input=<value> JSON body: literal JSON, @file, or - for stdin.
-m, --message=<value> Draft changelog or description.
--base-revision=<value> Base tag revision ID.
--field=<value>... Template field as key=value. Repeat for multiple fields.
--idempotency-key=<value> Idempotency key for replay-safe creation.
--name=<value> Display name for the generated template tag.
--tag-id=<value> Stable tag ID for the generated template tag.
--template=<value> Built-in template ID to add, for example google-analytics or segment.
--title=<value> Draft title.
--trigger=<value>... Template trigger preset. Repeat for multiple triggers.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Create a tag revision.
Create a mutable draft tag revision from a release, base revision, or graph body.
ALIASES
$ sf tags revisions add
EXAMPLES
Create a draft tag revision.
$ sf tags revisions create --space docs --title "Add GA"
Create a draft from a built-in template.
$ sf tags revisions create --space docs --template google-analytics --field measurementId=G-123
See code: src/commands/tags/revisions/create.ts
sf tags revisions diff REVISION
Diff a tag revision.
USAGE
$ sf tags revisions diff REVISION [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>]
ARGUMENTS
REVISION Tag revision 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Diff a tag revision.
Show the generated change set from this tag revision's base revision.
EXAMPLES
Show a tag revision's change set from its base.
$ sf tags revisions diff tver_123 --space docs
See code: src/commands/tags/revisions/diff.ts
sf tags revisions submit REVISION
Submit a tag revision.
USAGE
$ sf tags revisions submit REVISION [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>] [--idempotency-key <value>]
ARGUMENTS
REVISION Tag revision ID.
FLAGS
--idempotency-key=<value> Idempotency key for replay-safe submit.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Submit a tag revision.
Submit a mutable tag revision for review.
EXAMPLES
Submit a tag revision for review.
$ sf tags revisions submit tver_123 --space docs
See code: src/commands/tags/revisions/submit.ts
sf tags revisions validate REVISION
Validate a tag revision.
USAGE
$ sf tags revisions validate REVISION [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
[--claim-token <value>] [-o <value>] [--space <value>] [--idempotency-key <value>]
ARGUMENTS
REVISION Tag revision ID.
FLAGS
--idempotency-key=<value> Idempotency key for replay-safe validation.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Validate a tag revision.
Validate a tag revision's graph, consent policy, CSP impact, limits, and review gates.
EXAMPLES
Validate a tag revision before approval.
$ sf tags revisions validate tver_123 --space docs
See code: src/commands/tags/revisions/validate.ts
sf tags templates
List tag templates.
USAGE
$ sf tags templates [--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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
List tag templates.
List built-in tag templates and event trigger presets.
EXAMPLES
List built-in tag templates and trigger presets.
$ sf tags templates
See code: src/commands/tags/templates.ts
sf teams
Manage 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Manage teams.
Manage teams and members.
EXAMPLES
Manage teams.
$ sf teams
See code: src/commands/teams.ts
sf teams accept INVITATION
Accept a team invitation.
USAGE
$ sf teams accept INVITATION [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
ARGUMENTS
INVITATION Invitation id from the invite link.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Accept a team invitation.
Accept a team invitation and join the team as the current login.
EXAMPLES
$ sf teams accept inv_123
See code: src/commands/teams/accept.ts
sf teams create NAME
Create a team.
USAGE
$ sf teams create NAME [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
ARGUMENTS
NAME Display name for the new team.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Create a team.
Create a new team owned by the current login.
ALIASES
$ sf teams add
EXAMPLES
Create a new team.
$ sf teams create "Acme Inc"
See code: src/commands/teams/create.ts
sf teams defaults [ROOTACCESS]
Manage future-space defaults.
USAGE
$ sf teams defaults [ROOTACCESS] [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-o
<value>]
ARGUMENTS
[ROOTACCESS] Future Space Grant preset: private, team, or public.
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Manage future-space defaults.
Show or set the Grant preset materialized for Spaces this team creates in the future.
EXAMPLES
Show the team's future-space default.
$ sf teams defaults
Make future spaces private by default.
$ sf teams defaults private
See code: src/commands/teams/defaults.ts
sf teams invitations
Manage 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Manage team invitations.
Manage team invitations.
EXAMPLES
Manage team invitations.
$ sf teams invitations
See code: src/commands/teams/invitations.ts
sf teams invitations add EMAILS
Create team invitations.
USAGE
$ sf teams invitations add EMAILS... [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y] [-o <value>]
[--role owner|admin|member]
ARGUMENTS
EMAILS... Email addresses 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Create team invitations.
Invite one or more people to a team.
ALIASES
$ sf teams invitations create
EXAMPLES
Invite multiple members to the team.
$ sf teams invitations add jane@example.com alex@example.com --role member
See code: src/commands/teams/invitations/add.ts
sf teams invitations cancel INVITATION
Cancel a team invitation.
USAGE
$ sf teams invitations cancel INVITATION [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
ARGUMENTS
INVITATION Invitation id.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Cancel a team invitation.
Cancel a team invitation.
EXAMPLES
$ sf teams invitations cancel inv_123
See code: src/commands/teams/invitations/cancel.ts
sf teams invitations ls
List 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
List team invitations.
List pending and historical team invitations.
ALIASES
$ sf teams invitations list
EXAMPLES
$ sf teams invitations ls
See code: src/commands/teams/invitations/ls.ts
sf teams invitations resend INVITATION
Resend a team invitation.
USAGE
$ sf teams invitations resend INVITATION [--json] [--api-url <value>] [--profile <value>] [--token <value>] [-y]
ARGUMENTS
INVITATION Invitation id.
GLOBAL FLAGS
-y, --yes [env: SPACEFAST_YES] Skip confirmation prompts.
--api-url=<value> [env: SPACEFAST_API_URL] Spacefast API base URL.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Resend a team invitation.
Resend a pending team invitation.
EXAMPLES
$ sf teams invitations resend inv_123
See code: src/commands/teams/invitations/resend.ts
sf teams ls
List 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
List teams.
List teams available to the current login.
ALIASES
$ sf teams list
EXAMPLES
$ sf teams ls
See code: src/commands/teams/ls.ts
sf teams members
Manage 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Manage team members.
Manage team members.
EXAMPLES
Manage team members.
$ sf teams members
See code: src/commands/teams/members.ts
sf teams members ls
List 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
List team members.
List members in a team.
ALIASES
$ sf teams members list
EXAMPLES
$ sf teams members ls
See code: src/commands/teams/members/ls.ts
sf teams members rm MEMBER
Remove 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Remove a team member.
Remove a member from a team.
ALIASES
$ sf teams members remove
$ sf teams members delete
EXAMPLES
$ sf teams members rm jane@example.com
See code: src/commands/teams/members/rm.ts
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Set default team.
Set the default team for future CLI publishes.
EXAMPLES
Set acme as the default team.
$ sf teams switch acme
See code: src/commands/teams/switch.ts
sf transfers accept ID
Accept a space transfer.
USAGE
$ sf transfers accept 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Accept a space transfer.
Accept a pending space transfer as a member of the target team.
ALIASES
$ sf transfers confirm
EXAMPLES
Accept a pending space transfer.
$ sf transfers accept trf_123
See code: src/commands/transfers/accept.ts
sf transfers cancel ID
Cancel 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Cancel a space transfer.
Cancel a pending space transfer.
EXAMPLES
$ sf transfers cancel trf_123
See code: src/commands/transfers/cancel.ts
sf unlink
Unlink this checkout from its space.
USAGE
$ sf unlink [--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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Unlink this checkout from its space.
Remove this checkout's Spacefast link and private local publish state.
EXAMPLES
Review and remove the nearest checkout link.
$ sf unlink
Remove the link non-interactively and print the removed files.
$ sf unlink --yes --json
See code: src/commands/unlink.ts
sf versions
Manage 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Manage versions.
List, promote, and roll back space versions.
EXAMPLES
Manage versions.
$ sf versions
See code: src/commands/versions.ts
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
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
See code: src/commands/versions/get.ts
sf versions ls
List 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
List space versions.
List space versions, marking the live one and any still publishing.
ALIASES
$ sf versions list
EXAMPLES
List versions for the linked space.
$ sf versions ls
List versions for a specific space.
$ sf versions ls --space docs
See code: src/commands/versions/ls.ts
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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--claim-token=<value> [env: SPACEFAST_CLAIM_TOKEN] Space key (sfc_…) for an unclaimed anonymous space.
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
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.
ALIASES
$ sf versions remove
$ sf versions delete
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
See code: src/commands/versions/rm.ts
sf whoami
Show 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.
--json Format output as json.
--profile=<value> [env: SPACEFAST_PROFILE] Named provider profile from `sf profiles`.
AUTHENTICATION FLAGS
--token=<value> [env: SPACEFAST_TOKEN] API key for non-interactive auth.
DESCRIPTION
Show the current Spacefast account.
Verify the active token and print the authenticated account.
EXAMPLES
Show the authenticated account.
$ sf whoami
Print the account as JSON for scripting.
$ sf whoami --json
See code: src/commands/whoami.ts
Common 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 apply [--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 `.spacefast/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 API key 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 timeout
Agent examples
sf 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 831 weekly downloads. As such, spacefast popularity was classified as not 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.
Package last updated on 10 Sep 2026
Related posts
Research
/Security News
PolinRider Spreads Through Compromised GitHub Accounts and Packagist
Operators behind PolinRider used a compromised GitHub account to plant malware in four development versions of a Packagist package with 700,000+ downloads.
By Karlo Zanki - Sep 17, 2026
Security News
GitHub Actions Adds cache-mode to Limit Cache Poisoning Risk
GitHub Actions now supports cache-mode, a least-privilege control on the Actions cache aimed at the cache poisoning technique behind recent compromises.
By Sarah Gooding - Sep 16, 2026