{ "commands": { "access": { "aliases": [], "args": {}, "description": "Revoke active visitor sessions. Use `sf share` to manage who can open a space.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "access", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Revoke visitor sessions.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "access.js" ], "aliasPermutations": [], "permutations": [ "access" ], "examples": [ { "command": "<%= config.bin %> access", "description": "Revoke visitor sessions." } ] }, "access:logout-all": { "aliases": [], "args": {}, "description": "Revoke every active private-open, share-link, and signed-in visitor session for the space.", "examples": [ { "command": "<%= config.bin %> access logout-all --space docs", "description": "Revoke every visitor session on the space." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "access:logout-all", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Revoke all visitor sessions.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "access", "logout-all.js" ], "aliasPermutations": [], "permutations": [ "access:logout-all", "logout-all:access" ] }, "activity": { "aliases": [], "args": {}, "description": "Read the activity feed for the selected space, or pass --all for every event visible to your account.", "examples": [ "<%= config.bin %> activity", "<%= config.bin %> activity --code version.promoted", "<%= config.bin %> activity --all --since 2026-06-01T00:00:00Z" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "all": { "name": "all", "summary": "Read account-wide activity instead of a single space.", "allowNo": false, "type": "boolean" }, "code": { "name": "code", "summary": "Filter by activity taxonomy code, for example version.promoted.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "since": { "name": "since", "summary": "Only events at or after this ISO timestamp.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "until": { "name": "until", "summary": "Only events before this ISO timestamp.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "limit": { "name": "limit", "summary": "Maximum number of events to return (default 50, max 100).", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "cursor": { "name": "cursor", "summary": "Pagination cursor from a previous response.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "activity", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Show activity events.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "activity.js" ], "aliasPermutations": [], "permutations": [ "activity" ] }, "agents:init": { "aliases": [], "args": {}, "description": "Create or update the Spacefast AGENTS.md snippet.", "examples": [ { "command": "<%= config.bin %> agents init", "description": "Insert or refresh the Spacefast block in AGENTS.md." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "agents:init", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Write Spacefast AGENTS.md guidance.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "agents", "init.js" ], "aliasPermutations": [], "permutations": [ "agents:init", "init:agents" ] }, "analytics": { "aliases": [], "args": {}, "description": "Print runtime analytics series.", "examples": [ { "command": "<%= config.bin %> analytics --space docs", "description": "Print the 7-day analytics series for a space." }, { "command": "<%= config.bin %> analytics --space docs --window 30d", "description": "Use a 30-day window." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "window": { "name": "window", "summary": "Analytics window.", "default": "7d", "hasDynamicHelp": false, "multiple": false, "options": [ "48h", "7d", "30d" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "analytics", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Print runtime analytics.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "analytics.js" ], "aliasPermutations": [], "permutations": [ "analytics" ] }, "api": { "aliases": [], "args": { "methodOrPath": { "description": "HTTP method (GET, POST, PATCH, PUT, DELETE) or request path.", "name": "methodOrPath", "required": true }, "path": { "description": "Request path, for example /v1/spaces/{spaceId}/versions.", "name": "path" } }, "description": "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": [ "<%= config.bin %> api /v1/me", "<%= config.bin %> api GET /v1/spaces/spc_123/versions --paginate", "<%= config.bin %> api POST /v1/publish --input @publish.json --idempotency-key 01J-logical-attempt", "<%= config.bin %> api GET /v1/spaces/spc_123/versions/ver_123/archive --output site.tar.gz" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "input": { "char": "i", "name": "input", "summary": "JSON request body: a literal string, @file, or - for stdin.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "idempotency-key": { "name": "idempotency-key", "summary": "Replay-safe logical-attempt key for retryable mutations.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "include": { "name": "include", "summary": "Write HTTP status and safe response headers to stderr.", "allowNo": false, "type": "boolean" }, "output": { "exclusive": [ "raw-stdout" ], "name": "output", "summary": "Write a non-JSON response body to a file.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "paginate": { "name": "paginate", "summary": "Emit every page of a declared cursor-list GET as JSON Lines.", "allowNo": false, "type": "boolean" }, "raw-stdout": { "exclusive": [ "output" ], "name": "raw-stdout", "summary": "Write a non-JSON response body to stdout.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "api", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Call the Spacefast API directly.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "api.js" ], "aliasPermutations": [], "permutations": [ "api" ] }, "api-keys": { "aliases": [], "args": {}, "description": "Manage API keys.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "api-keys", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Manage API keys.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "api-keys.js" ], "aliasPermutations": [], "permutations": [ "api-keys" ], "examples": [ { "command": "<%= config.bin %> api-keys", "description": "Manage API keys." } ] }, "api-keys:create": { "aliases": [ "api-keys:add" ], "args": {}, "description": "Create an API key and print its one-time secret.", "examples": [ { "command": "<%= config.bin %> api-keys create --name ci", "description": "Create an API key and print its one-time secret." }, { "command": "<%= config.bin %> api-keys create --name ci --preset full_access", "description": "Create a key with a specific access preset." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "name": { "char": "n", "name": "name", "summary": "Human-readable API key name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "preset": { "name": "preset", "summary": "Access preset for the new API key.", "default": "space_publisher", "hasDynamicHelp": false, "multiple": false, "options": [ "ci_deploy", "space_publisher", "space_admin", "domain_manager", "team_admin", "billing_viewer", "partner_admin" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "api-keys:create", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Create an API key.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "api-keys", "create.js" ], "aliasPermutations": [ "api-keys:add", "add:api-keys" ], "permutations": [ "api-keys:create", "create:api-keys" ] }, "api-keys:list": { "aliases": [ "api-keys:ls" ], "args": {}, "description": "List API keys for the selected team.", "examples": [ { "command": "<%= config.bin %> api-keys ls", "description": "List API keys for the selected team." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "limit": { "name": "limit", "summary": "Maximum number of API keys to return (default 50, max 100).", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "api-keys:list", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List API keys.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "api-keys", "list.js" ], "aliasPermutations": [ "api-keys:ls", "ls:api-keys" ], "permutations": [ "api-keys:list", "list:api-keys" ] }, "api-keys:revoke": { "aliases": [ "api-keys:delete", "api-keys:remove", "api-keys:rm" ], "args": { "id": { "description": "API key id.", "name": "id", "required": true } }, "description": "Revoke an API key.", "examples": [ { "command": "<%= config.bin %> api-keys revoke key_123", "description": "Revoke an API key by ID." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "api-keys:revoke", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Revoke an API key.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "api-keys", "revoke.js" ], "aliasPermutations": [ "api-keys:delete", "delete:api-keys", "api-keys:remove", "remove:api-keys", "api-keys:rm", "rm:api-keys" ], "permutations": [ "api-keys:revoke", "revoke:api-keys" ] }, "apply": { "aliases": [], "args": {}, "description": "Push saved space settings that are not live yet onto the serving runtime.", "examples": [ { "command": "<%= config.bin %> apply", "description": "Apply the linked space's saved changes and wait for them to go live." }, { "command": "<%= config.bin %> apply --space docs --no-wait", "description": "Queue an apply for a specific space without waiting." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "wait": { "helpGroup": "Execution", "name": "wait", "summary": "Wait until queued work finishes before returning.", "allowNo": true, "type": "boolean" }, "wait-timeout": { "helpGroup": "Execution", "name": "wait-timeout", "summary": "Seconds to wait for the apply to finish.", "default": 900, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "apply", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Apply saved changes to the live runtime.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "apply.js" ], "aliasPermutations": [], "permutations": [ "apply" ] }, "auth": { "aliases": [], "args": {}, "description": "Authenticate the CLI with Spacefast.", "examples": [ "<%= config.bin %> auth login" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "auth", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Authenticate the CLI.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "auth.js" ], "aliasPermutations": [], "permutations": [ "auth" ] }, "build": { "aliases": [], "args": { "dir": { "description": "Project directory to build. Defaults to the current directory.", "name": "dir", "required": false } }, "description": "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": [ { "command": "<%= config.bin %> build", "description": "Detect build settings, run the build, and pack the output archive." }, { "command": "<%= config.bin %> build --root-directory apps/web --output ./apps/web.tgz", "description": "Build a monorepo app and write the archive to a custom path." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "root-directory": { "helpGroup": "Build", "name": "root-directory", "summary": "Project subdirectory that contains the app.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "install-directory": { "helpGroup": "Build", "name": "install-directory", "summary": "Project subdirectory to run dependency installation from.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "install-command": { "helpGroup": "Build", "name": "install-command", "summary": "Install command. Defaults to package-manager detection.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "build-command": { "helpGroup": "Build", "name": "build-command", "summary": "Build command. Defaults to framework and package script detection.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "output-directory": { "helpGroup": "Build", "name": "output-directory", "summary": "Build output directory relative to the app root.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env-file": { "helpGroup": "Build", "name": "env-file", "summary": "Local dotenv file to load for install/build commands. Repeat for multiple files.", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "ignored-build-command": { "helpGroup": "Build", "name": "ignored-build-command", "summary": "Command that exits 0 when this build should be skipped.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "skip-install": { "helpGroup": "Build", "name": "skip-install", "summary": "Skip the install command.", "allowNo": false, "type": "boolean" }, "skip-build": { "helpGroup": "Build", "name": "skip-build", "summary": "Skip the build command and pack the selected directory unless --output-directory is set.", "allowNo": false, "type": "boolean" }, "prebuilt": { "helpGroup": "Build", "name": "prebuilt", "summary": "Pack an already-built output directory; skips install and build.", "allowNo": false, "type": "boolean" }, "output": { "helpGroup": "Execution", "name": "output", "summary": "Archive path to write.", "default": ".spacefast/build-output.tgz", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "dry-run": { "helpGroup": "Execution", "name": "dry-run", "summary": "Print the detected build plan without installing, building, or packing.", "allowNo": false, "type": "boolean" }, "stream": { "helpGroup": "Execution", "name": "stream", "summary": "With --json, emit a JSONL build event stream. Use --no-stream for a single result blob.", "allowNo": true, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "build", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Build and pack project output.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "build.js" ], "aliasPermutations": [], "permutations": [ "build" ] }, "builds:cancel": { "aliases": [], "args": { "build": { "description": "Build ID (bld_...).", "name": "build", "required": true } }, "description": "Cancel a build. Idempotent: a build already in a terminal state is returned unchanged.", "examples": [ "<%= config.bin %> builds cancel bld_123" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "builds:cancel", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Cancel a build.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "builds", "cancel.js" ], "aliasPermutations": [], "permutations": [ "builds:cancel", "cancel:builds" ] }, "builds:detect": { "aliases": [], "args": {}, "description": "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": [ { "command": "<%= config.bin %> builds detect --space docs", "description": "Show detected framework and build settings for the repository connection." }, { "command": "<%= config.bin %> builds detect --space docs --root-directory apps/web --apply-best", "description": "Detect and save the best build settings for a subdirectory." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "connection-type": { "helpGroup": "Repository", "name": "connection-type", "summary": "Repository connection type.", "default": "connected", "hasDynamicHelp": false, "multiple": false, "options": [ "connected", "hosted" ], "type": "option" }, "ref": { "helpGroup": "Repository", "name": "ref", "summary": "Git ref to inspect.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "root-directory": { "helpGroup": "Build", "name": "root-directory", "summary": "App root directory to inspect.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "apply-best": { "helpGroup": "Build", "name": "apply-best", "summary": "Save the highest-ranked detected app candidate as repository build settings.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [ "git:analyze" ], "id": "builds:detect", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Detect framework and build settings.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "builds", "detect.js" ], "aliasPermutations": [], "permutations": [ "builds:detect", "detect:builds" ] }, "builds:get": { "aliases": [], "args": { "build": { "description": "Build ID (bld_...).", "name": "build", "required": true } }, "description": "Fetch a build by id.", "examples": [ { "command": "<%= config.bin %> builds get bld_123", "description": "Show a build by ID." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "builds:get", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Show a build.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "builds", "get.js" ], "aliasPermutations": [], "permutations": [ "builds:get", "get:builds" ] }, "builds:logs": { "aliases": [], "args": { "build": { "description": "Build ID (bld_...).", "name": "build", "required": true } }, "description": "Print build runner log lines, newest first.", "examples": [ { "command": "<%= config.bin %> builds logs bld_123", "description": "Print recent log lines for a build." }, { "command": "<%= config.bin %> builds logs bld_123 --follow", "description": "Stream logs until the build finishes." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "limit": { "name": "limit", "summary": "Maximum number of log lines.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "cursor": { "name": "cursor", "summary": "Pagination cursor from a previous response.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "follow": { "char": "f", "name": "follow", "summary": "Follow live build logs until the build reaches a terminal state.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "builds:logs", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Print build logs.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "builds", "logs.js" ], "aliasPermutations": [], "permutations": [ "builds:logs", "logs:builds" ] }, "builds:ls": { "aliases": [ "builds:list" ], "args": {}, "description": "List a space's builds, newest first.", "examples": [ { "command": "<%= config.bin %> builds ls --space docs", "description": "List recent builds for a space." }, { "command": "<%= config.bin %> builds ls --space docs --limit 5", "description": "Show only the five most recent builds." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "limit": { "name": "limit", "summary": "Maximum number of builds to return (default 20, max 100).", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "cursor": { "name": "cursor", "summary": "Pagination cursor from a previous response.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "builds:ls", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List builds.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "builds", "ls.js" ], "aliasPermutations": [ "builds:list", "list:builds" ], "permutations": [ "builds:ls", "ls:builds" ] }, "builds:refresh-upload": { "aliases": [], "args": { "build": { "description": "Build ID (bld_...) waiting for source archive upload.", "name": "build", "required": true } }, "description": "Refresh the upload instruction for a build waiting on its source archive.", "examples": [ { "command": "<%= config.bin %> builds refresh-upload bld_123", "description": "Refresh the source archive upload instruction for a build." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "builds:refresh-upload", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Refresh source archive upload.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "builds", "refresh-upload.js" ], "aliasPermutations": [], "permutations": [ "builds:refresh-upload", "refresh-upload:builds" ] }, "builds:retry": { "aliases": [], "args": { "build": { "description": "Build ID (bld_...) to retry.", "name": "build", "required": true } }, "description": "Retry a terminal build with the same input, settings, and target.", "examples": [ "<%= config.bin %> builds retry bld_123" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "builds:retry", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Retry a terminal build.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "builds", "retry.js" ], "aliasPermutations": [], "permutations": [ "builds:retry", "retry:builds" ] }, "channels": { "aliases": [], "args": {}, "description": "List channels, set how each promotes, and inspect promotion history.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "channels", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Manage channels.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "channels.js" ], "aliasPermutations": [], "permutations": [ "channels" ], "examples": [ { "command": "<%= config.bin %> channels", "description": "Manage channels." } ] }, "channels:history": { "aliases": [], "args": { "name": { "description": "Channel name. Defaults to `live`.", "name": "name", "required": false } }, "description": "Show what this channel has gone live with, newest first.", "examples": [ { "command": "<%= config.bin %> channels history --space docs", "description": "Show promotion history for the live channel." }, { "command": "<%= config.bin %> channels history preview --space docs", "description": "Show promotion history for the preview channel." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "channels:history", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Show channel history.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "channels", "history.js" ], "aliasPermutations": [], "permutations": [ "channels:history", "history:channels" ] }, "channels:ls": { "aliases": [ "channels:list" ], "args": {}, "description": "List channels for a space and where each one points.", "examples": [ { "command": "<%= config.bin %> channels ls --space docs", "description": "List channels for the docs space." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "channels:ls", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List channels.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "channels", "ls.js" ], "aliasPermutations": [ "channels:list", "list:channels" ], "permutations": [ "channels:ls", "ls:channels" ] }, "channels:set": { "aliases": [], "args": { "name": { "description": "Channel name (live).", "name": "name", "required": true } }, "description": "Set a channel's promotion policy. Only `live` exists today, and promoting a version by hand always works — the policy only decides what goes live without you asking.", "examples": [ { "command": "<%= config.bin %> channels set live --promotion manual --space dashboard", "description": "Hold the dashboard's live channel for promote-driven deploys." }, { "command": "<%= config.bin %> channels set live --promotion auto", "description": "Go back to publishing straight to live." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "promotion": { "description": "auto: publishes and green builds go live. manual: hold everything until an explicit promote.", "name": "promotion", "required": true, "summary": "Promotion policy for the channel.", "hasDynamicHelp": false, "multiple": false, "options": [ "auto", "manual" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "channels:set", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Set a channel's promotion policy.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "channels", "set.js" ], "aliasPermutations": [], "permutations": [ "channels:set", "set:channels" ] }, "comments": { "aliases": [], "args": {}, "description": "List, export, and update persistent Space comments, and set where Comments run.", "flags": {}, "hasDynamicHelp": false, "hiddenAliases": [], "id": "comments", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Manage comments.", "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "comments.js" ], "aliasPermutations": [], "permutations": [ "comments" ], "examples": [ { "command": "<%= config.bin %> comments", "description": "Manage comments." } ] }, "comments:archive": { "aliases": [], "args": { "comment": { "description": "Comment id, for example cmt_123.", "name": "comment", "required": true } }, "description": "Archive a comment thread.", "examples": [ "<%= config.bin %> comments archive cmt_123" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "comments:archive", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Archive a comment.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "comments", "archive.js" ], "aliasPermutations": [], "permutations": [ "comments:archive", "archive:comments" ] }, "comments:export": { "aliases": [], "args": {}, "description": "Export comment threads for agents and scripts.", "examples": [ { "command": "<%= config.bin %> comments export --status open --format markdown", "description": "Export every open thread in the space as markdown." }, { "command": "<%= config.bin %> comments export --version v3 --status open --format json", "description": "Export open comments filtered to version v3 as JSON." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "version": { "name": "version", "summary": "Filter by version ID, ref, or number.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "format": { "name": "format", "summary": "Export format.", "default": "markdown", "hasDynamicHelp": false, "multiple": false, "options": [ "markdown", "json" ], "type": "option" }, "status": { "name": "status", "summary": "Filter by status.", "hasDynamicHelp": false, "multiple": false, "options": [ "open", "archived" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "comments:export", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Export comments.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "comments", "export.js" ], "aliasPermutations": [], "permutations": [ "comments:export", "export:comments" ] }, "comments:get": { "aliases": [], "args": { "comment": { "description": "Comment id, for example cmt_123.", "name": "comment", "required": true } }, "description": "Show one comment thread.", "examples": [ "<%= config.bin %> comments get cmt_123" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "comments:get", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Show a comment.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "comments", "get.js" ], "aliasPermutations": [], "permutations": [ "comments:get", "get:comments" ] }, "comments:list": { "aliases": [ "comments:ls" ], "args": {}, "description": "List persistent comment threads across a space.", "examples": [ { "command": "<%= config.bin %> comments list --status open --path /pricing", "description": "List open comments on the pricing route across publishes." }, { "command": "<%= config.bin %> comments list --version v3", "description": "Filter comments by their version context." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "version": { "name": "version", "summary": "Filter by version ID, ref, or number.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "status": { "name": "status", "summary": "Filter by status.", "hasDynamicHelp": false, "multiple": false, "options": [ "open", "archived" ], "type": "option" }, "path": { "name": "path", "summary": "Filter by page path.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "limit": { "name": "limit", "summary": "Maximum comments to return.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "comments:list", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List comments.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "comments", "list.js" ], "aliasPermutations": [ "comments:ls", "ls:comments" ], "permutations": [ "comments:list", "list:comments" ] }, "comments:reply": { "aliases": [], "args": { "comment": { "description": "Comment id, for example cmt_123.", "name": "comment", "required": true } }, "description": "Reply to a comment thread.", "examples": [ "<%= config.bin %> comments reply cmt_123 --body \"Fixed in v4.\"" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "body": { "name": "body", "required": true, "summary": "Reply body.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "idempotency-key": { "name": "idempotency-key", "summary": "Stable key for safely retrying this reply.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "comments:reply", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Reply to a comment.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "comments", "reply.js" ], "aliasPermutations": [], "permutations": [ "comments:reply", "reply:comments" ] }, "comments:settings": { "aliases": [], "args": {}, "description": "Show where Comments run for a Space and which third-party sites may embed them. Change them with `comments settings set`.", "examples": [ { "command": "<%= config.bin %> comments settings", "description": "Show Comments settings for the linked Space." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "comments:settings", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Show Comments settings.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "comments", "settings.js" ], "aliasPermutations": [], "permutations": [ "comments:settings", "settings:comments" ] }, "comments:settings:set": { "aliases": [], "args": {}, "description": "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": [ { "command": "<%= config.bin %> comments settings set --surface everywhere", "description": "Run Comments on version previews and the live Space." }, { "command": "<%= config.bin %> comments settings set --embed-allow https://docs.example.com", "description": "Let docs.example.com embed this Space's Comments." }, { "command": "<%= config.bin %> comments settings set --embed-remove https://docs.example.com", "description": "Cut docs.example.com off from this Space's Comments." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "surface": { "helpGroup": "Comments", "name": "surface", "summary": "Where Comments run: off, previews, or everywhere.", "hasDynamicHelp": false, "multiple": false, "options": [ "off", "previews", "everywhere" ], "type": "option" }, "embed-allow": { "helpGroup": "Embedding", "name": "embed-allow", "summary": "Site allowed to embed this Space's Comments, e.g. https://docs.example.com.", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "embed-remove": { "helpGroup": "Embedding", "name": "embed-remove", "summary": "Site to cut off from embedding this Space's Comments.", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "comments:settings:set", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Change Comments settings.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "comments", "settings", "set.js" ], "aliasPermutations": [], "permutations": [ "comments:settings:set", "settings:comments:set", "settings:set:comments", "comments:set:settings", "set:comments:settings", "set:settings:comments" ] }, "comments:unarchive": { "aliases": [], "args": { "comment": { "description": "Comment id, for example cmt_123.", "name": "comment", "required": true } }, "description": "Unarchive a comment thread.", "examples": [ "<%= config.bin %> comments unarchive cmt_123" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "comments:unarchive", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Unarchive a comment.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "comments", "unarchive.js" ], "aliasPermutations": [], "permutations": [ "comments:unarchive", "unarchive:comments" ] }, "connectors": { "aliases": [], "args": {}, "description": "Everything about a team's connectors: register tool sources (OpenAPI specs, GraphQL endpoints, remote MCP servers), connect accounts, decide policies, and run tools.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "connectors", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Manage connectors.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "connectors.js" ], "aliasPermutations": [], "permutations": [ "connectors" ], "examples": [ { "command": "<%= config.bin %> connectors", "description": "Manage connectors." } ] }, "connectors:add": { "aliases": [], "args": { "target": { "description": "Spec, endpoint, or MCP URL to detect, or a catalog slug to add straight from the catalog.", "name": "target", "required": true } }, "description": "Register a connector. A URL is probed first and registered as whatever the detectors recognize; a catalog slug skips the probe and adds the curated row.", "examples": [ { "command": "<%= config.bin %> connectors add https://api.example.com/openapi.json", "description": "Detect what is behind a URL and register it." }, { "command": "<%= config.bin %> connectors add linear --slug linear", "description": "Add a catalog row by slug." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "slug": { "name": "slug", "summary": "Connector slug. Defaults to the detected or catalog slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "title": { "name": "title", "summary": "Display name. Defaults to what the source calls itself.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "description": { "name": "description", "summary": "Agent-visible note on what this connector reaches.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "connectors:add", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Register a connector.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "connectors", "add.js" ], "aliasPermutations": [], "permutations": [ "connectors:add", "add:connectors" ] }, "connectors:bind": { "aliases": [], "args": { "role": { "description": "Capsule connector role.", "name": "role", "required": true }, "connection": { "description": "Connection id.", "name": "connection", "required": true } }, "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "connectors:bind", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Bind a capsule role to a connection.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "connectors", "bind.js" ], "aliasPermutations": [], "permutations": [ "connectors:bind", "bind:connectors" ], "examples": [ { "command": "<%= config.bin %> connectors bind ", "description": "Bind a capsule role to a connection." } ] }, "connectors:bindings": { "aliases": [], "args": {}, "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "connectors:bindings", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List a Space's connector roles and bindings.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "connectors", "bindings.js" ], "aliasPermutations": [], "permutations": [ "connectors:bindings", "bindings:connectors" ], "examples": [ { "command": "<%= config.bin %> connectors bindings", "description": "List a Space's connector roles and bindings." } ] }, "connectors:connections": { "aliases": [], "args": {}, "description": "Connect accounts to a team's connectors and inspect the ones you can already use. Credentials are write-only: they go in here and no endpoint hands them back.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "connectors:connections", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Manage connections.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "connectors", "connections.js" ], "aliasPermutations": [], "permutations": [ "connectors:connections", "connections:connectors" ], "examples": [ { "command": "<%= config.bin %> connectors connections", "description": "Manage connections." } ] }, "connectors:connections:add": { "aliases": [ "connectors:connections:connect" ], "args": { "connector": { "description": "Connector slug to connect.", "name": "connector", "required": true } }, "description": "Connect an account in one call. The answer is one of three: connected, an authorization URL to open in a browser, or the fields to collect and pass back. Credentials are sealed on arrival and never returned.", "examples": [ { "command": "<%= config.bin %> connectors connections add stripe --api-key $STRIPE_KEY", "description": "Connect with an API key the team shares." }, { "command": "<%= config.bin %> connectors connections add linear --owner personal", "description": "Start an OAuth connection that only you can use." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "api-key": { "helpGroup": "Credential", "name": "api-key", "noCacheDefault": true, "summary": "API key for connectors that take one. Never echoed back, in any output mode.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "field": { "helpGroup": "Credential", "name": "field", "noCacheDefault": true, "summary": "name=value for a connector that asks for several values. Repeat per field.", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "owner": { "name": "owner", "summary": "Share it with the team (default), or keep it yours within this team.", "hasDynamicHelp": false, "multiple": false, "options": [ "team", "personal" ], "type": "option" }, "name": { "name": "name", "summary": "What to call it. Defaults to the connector's title.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "description": { "name": "description", "summary": "Agent-visible note on what this connection is for.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "auth-method": { "name": "auth-method", "summary": "Which of the connector's auth methods to use, when more than one applies.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "connectors:connections:add", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Connect an account.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "connectors", "connections", "add.js" ], "aliasPermutations": [ "connectors:connections:connect", "connections:connectors:connect", "connections:connect:connectors", "connectors:connect:connections", "connect:connectors:connections", "connect:connections:connectors" ], "permutations": [ "connectors:connections:add", "connections:connectors:add", "connections:add:connectors", "connectors:add:connections", "add:connectors:connections", "add:connections:connectors" ] }, "connectors:connections:edit": { "aliases": [ "connectors:connections:update" ], "args": { "connection": { "description": "Connection id, for example cxn_abc123.", "name": "connection", "required": true } }, "description": "Rename a connection, change its agent-visible note, or grant sites access. Credentials are immutable: to rotate one, reconnect.", "examples": [ { "command": "<%= config.bin %> connectors connections edit cxn_abc123 --name \"Stripe (prod)\"", "description": "Rename a connection." }, { "command": "<%= config.bin %> connectors connections edit cxn_abc123 --description \"Billing, production\"", "description": "Tell agents what it is for." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "serving": { "name": "serving", "summary": "Allow bound sites to act as this team account for every visitor.", "allowNo": true, "type": "boolean" }, "name": { "name": "name", "summary": "Replacement label.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "description": { "name": "description", "summary": "Replacement agent-visible note. Pass an empty string to clear it.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "connectors:connections:edit", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Edit a connection.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "connectors", "connections", "edit.js" ], "aliasPermutations": [ "connectors:connections:update", "connections:connectors:update", "connections:update:connectors", "connectors:update:connections", "update:connectors:connections", "update:connections:connectors" ], "permutations": [ "connectors:connections:edit", "connections:connectors:edit", "connections:edit:connectors", "connectors:edit:connections", "edit:connectors:connections", "edit:connections:connectors" ] }, "connectors:connections:health": { "aliases": [], "args": { "connection": { "description": "Connection id, for example cxn_abc123.", "name": "connection", "required": true } }, "description": "Probe a connection against the provider and report what came back. It only reports: an expired token refreshes on its own.", "examples": [ { "command": "<%= config.bin %> connectors connections health cxn_abc123", "description": "Check one connection right now." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "connectors:connections:health", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Probe a connection.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "connectors", "connections", "health.js" ], "aliasPermutations": [], "permutations": [ "connectors:connections:health", "connections:connectors:health", "connections:health:connectors", "connectors:health:connections", "health:connectors:connections", "health:connections:connectors" ] }, "connectors:connections:ls": { "aliases": [ "connectors:connections:list" ], "args": {}, "description": "List the connections this credential may use: the team's shared ones plus your own personal ones.", "examples": [ { "command": "<%= config.bin %> connectors connections ls", "description": "List usable connections." }, { "command": "<%= config.bin %> connectors connections ls --owner personal", "description": "List only your own connections in this team." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "owner": { "name": "owner", "summary": "Whose connections to list. `any` is everything you may use (default).", "hasDynamicHelp": false, "multiple": false, "options": [ "team", "personal", "any" ], "type": "option" }, "connector": { "name": "connector", "summary": "Show only connections of this connector.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "status": { "name": "status", "summary": "Show only connections in this state.", "hasDynamicHelp": false, "multiple": false, "options": [ "pending_authorization", "active", "degraded", "needs_reauth", "revoked" ], "type": "option" }, "include-revoked": { "name": "include-revoked", "summary": "Include disconnected connections.", "allowNo": false, "type": "boolean" }, "limit": { "name": "limit", "summary": "Maximum connections to return (default 50).", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "connectors:connections:ls", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List connections.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "connectors", "connections", "ls.js" ], "aliasPermutations": [ "connectors:connections:list", "connections:connectors:list", "connections:list:connectors", "connectors:list:connections", "list:connectors:connections", "list:connections:connectors" ], "permutations": [ "connectors:connections:ls", "connections:connectors:ls", "connections:ls:connectors", "connectors:ls:connections", "ls:connectors:connections", "ls:connections:connectors" ] }, "connectors:connections:refresh": { "aliases": [ "connectors:connections:sync" ], "args": { "connection": { "description": "Connection id, for example cxn_abc123.", "name": "connection", "required": true } }, "description": "Re-resolve the tool catalog behind a connection, so tools the provider added or dropped show up. Token refresh happens on its own; this is about the tools.", "examples": [ { "command": "<%= config.bin %> connectors connections refresh cxn_abc123", "description": "Pick up the provider's newest tools." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "connectors:connections:refresh", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Re-sync a connection's tools.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "connectors", "connections", "refresh.js" ], "aliasPermutations": [ "connectors:connections:sync", "connections:connectors:sync", "connections:sync:connectors", "connectors:sync:connections", "sync:connectors:connections", "sync:connections:connectors" ], "permutations": [ "connectors:connections:refresh", "connections:connectors:refresh", "connections:refresh:connectors", "connectors:refresh:connections", "refresh:connectors:connections", "refresh:connections:connectors" ] }, "connectors:connections:rm": { "aliases": [ "connectors:connections:remove", "connectors:connections:disconnect" ], "args": { "connection": { "description": "Connection id, for example cxn_abc123.", "name": "connection", "required": true } }, "description": "Disconnect a connection: the stored credential is purged, the row tombstones, and anything addressing it stops working.", "examples": [ { "command": "<%= config.bin %> connectors connections rm cxn_abc123 --yes", "description": "Disconnect without prompting." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "connectors:connections:rm", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Disconnect a connection.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "connectors", "connections", "rm.js" ], "aliasPermutations": [ "connectors:connections:remove", "connections:connectors:remove", "connections:remove:connectors", "connectors:remove:connections", "remove:connectors:connections", "remove:connections:connectors", "connectors:connections:disconnect", "connections:connectors:disconnect", "connections:disconnect:connectors", "connectors:disconnect:connections", "disconnect:connectors:connections", "disconnect:connections:connectors" ], "permutations": [ "connectors:connections:rm", "connections:connectors:rm", "connections:rm:connectors", "connectors:rm:connections", "rm:connectors:connections", "rm:connections:connectors" ] }, "connectors:detect": { "aliases": [], "args": { "url": { "description": "Any URL a service published.", "name": "url", "required": true } }, "description": "Probe a URL and report the connectors behind it, most confident first. The URL worth registering is often not the one you pasted.", "examples": [ { "command": "<%= config.bin %> connectors detect https://api.example.com", "description": "See what could be registered from a URL." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "connectors:detect", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Detect what is behind a URL.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "connectors", "detect.js" ], "aliasPermutations": [], "permutations": [ "connectors:detect", "detect:connectors" ] }, "connectors:ls": { "aliases": [ "connectors:list" ], "args": {}, "description": "List the connectors this team registered, with how many connections you can use on each.", "examples": [ { "command": "<%= config.bin %> connectors ls", "description": "List the team's connectors." }, { "command": "<%= config.bin %> connectors ls --source mcp", "description": "List only connectors backed by an MCP server." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "query": { "name": "query", "summary": "Filter over slug, title, and description.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "source": { "name": "source", "summary": "Show only connectors built from this kind of source.", "hasDynamicHelp": false, "multiple": false, "options": [ "openapi", "graphql", "mcp" ], "type": "option" }, "limit": { "name": "limit", "summary": "Maximum connectors to return (default 50).", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "connectors:ls", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List connectors.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "connectors", "ls.js" ], "aliasPermutations": [ "connectors:list", "list:connectors" ], "permutations": [ "connectors:ls", "ls:connectors" ] }, "connectors:policies": { "aliases": [], "args": {}, "description": "Decide what an agent may call. A rule is an address pattern — `*`, `/*`, `/*`, or `/` — and what happens when it matches. The most specific pattern wins, and team rules are a floor personal rules cannot loosen.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "connectors:policies", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Manage connector policy rules.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "connectors", "policies.js" ], "aliasPermutations": [], "permutations": [ "connectors:policies", "policies:connectors" ], "examples": [ { "command": "<%= config.bin %> connectors policies", "description": "Manage connector policy rules." } ] }, "connectors:policies:add": { "aliases": [], "args": { "pattern": { "description": "`*`, `/*`, `/*`, or `/`. Quote it — the shell eats a bare `*`.", "name": "pattern", "required": true } }, "description": "Add a rule over an address pattern. Its position comes from the pattern's specificity, so the narrower rule always wins. A team rule is a floor: a personal rule may tighten it, never loosen it.", "examples": [ { "command": "<%= config.bin %> connectors policies add '*' --action require_approval", "description": "Park everything for a person by default." }, { "command": "<%= config.bin %> connectors policies add 'cxn_abc123/charges.create' --action block", "description": "Refuse one tool outright." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "action": { "name": "action", "summary": "Run the call, park it for a person, or refuse it.", "hasDynamicHelp": false, "multiple": false, "options": [ "approve", "require_approval", "block" ], "type": "option" }, "owner": { "name": "owner", "summary": "Apply it to the whole team (default), or only to your own calls in this team.", "hasDynamicHelp": false, "multiple": false, "options": [ "team", "personal" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "connectors:policies:add", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Add a policy rule.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "connectors", "policies", "add.js" ], "aliasPermutations": [], "permutations": [ "connectors:policies:add", "policies:connectors:add", "policies:add:connectors", "connectors:add:policies", "add:connectors:policies", "add:policies:connectors" ] }, "connectors:policies:explain": { "aliases": [], "args": { "address": { "description": "Tool address: `/`.", "name": "address", "required": true } }, "description": "Answer what happens if you call one address, and why, without calling it. Reports the effect, the rule that decided it, and the reason in a sentence.", "examples": [ { "command": "<%= config.bin %> connectors policies explain cxn_abc123/charges.create", "description": "Check one tool before an agent hits it." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "connectors:policies:explain", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Explain what happens for one address.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "connectors", "policies", "explain.js" ], "aliasPermutations": [], "permutations": [ "connectors:policies:explain", "policies:connectors:explain", "policies:explain:connectors", "connectors:explain:policies", "explain:connectors:policies", "explain:policies:connectors" ] }, "connectors:policies:ls": { "aliases": [ "connectors:policies:list" ], "args": {}, "description": "List the rules that decide what an agent may call: the team's, plus your own personal ones. An address nothing matches falls through to the connector's own default.", "examples": [ { "command": "<%= config.bin %> connectors policies ls", "description": "List the rules in force." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "connectors:policies:ls", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List policy rules.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "connectors", "policies", "ls.js" ], "aliasPermutations": [ "connectors:policies:list", "policies:connectors:list", "policies:list:connectors", "connectors:list:policies", "list:connectors:policies", "list:policies:connectors" ], "permutations": [ "connectors:policies:ls", "policies:connectors:ls", "policies:ls:connectors", "connectors:ls:policies", "ls:connectors:policies", "ls:policies:connectors" ] }, "connectors:policies:rm": { "aliases": [ "connectors:policies:remove", "connectors:policies:delete" ], "args": { "rule": { "description": "Rule id, from `sf connectors policies ls`.", "name": "rule", "required": true } }, "description": "Remove a rule. Whatever it decided falls through to the next rule that matches, or to the connector's own default — so removing a block can open a tool back up.", "examples": [ { "command": "<%= config.bin %> connectors policies rm pol_abc123 --yes", "description": "Remove a rule without prompting." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "connectors:policies:rm", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Remove a policy rule.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "connectors", "policies", "rm.js" ], "aliasPermutations": [ "connectors:policies:remove", "policies:connectors:remove", "policies:remove:connectors", "connectors:remove:policies", "remove:connectors:policies", "remove:policies:connectors", "connectors:policies:delete", "policies:connectors:delete", "policies:delete:connectors", "connectors:delete:policies", "delete:connectors:policies", "delete:policies:connectors" ], "permutations": [ "connectors:policies:rm", "policies:connectors:rm", "policies:rm:connectors", "connectors:rm:policies", "rm:connectors:policies", "rm:policies:connectors" ] }, "connectors:policies:set": { "aliases": [], "args": { "rule": { "description": "Rule id, from `sf connectors policies ls`.", "name": "rule", "required": true } }, "description": "Change what a rule does. Its pattern and owner are fixed — remove it and add the one you meant.", "examples": [ { "command": "<%= config.bin %> connectors policies set pol_abc123 --action block", "description": "Turn a parked rule into a refusal." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "action": { "name": "action", "summary": "Run the call, park it for a person, or refuse it.", "hasDynamicHelp": false, "multiple": false, "options": [ "approve", "require_approval", "block" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "connectors:policies:set", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Change a policy rule's action.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "connectors", "policies", "set.js" ], "aliasPermutations": [], "permutations": [ "connectors:policies:set", "policies:connectors:set", "policies:set:connectors", "connectors:set:policies", "set:connectors:policies", "set:policies:connectors" ] }, "connectors:rm": { "aliases": [ "connectors:remove", "connectors:delete" ], "args": { "connector": { "description": "Connector slug.", "name": "connector", "required": true } }, "description": "Remove a connector and its tools. The API refuses while any live connection still uses it — disconnect those first.", "examples": [ { "command": "<%= config.bin %> connectors rm linear --yes", "description": "Remove a connector without prompting." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "connectors:rm", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Remove a connector.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "connectors", "rm.js" ], "aliasPermutations": [ "connectors:remove", "remove:connectors", "connectors:delete", "delete:connectors" ], "permutations": [ "connectors:rm", "rm:connectors" ] }, "connectors:run": { "aliases": [], "args": { "code": { "description": "A program to run in the sandbox. It may call any tool this credential is granted. Omit it when using --tool.", "name": "code", "required": false } }, "description": "Run one connector tool, or a program that calls several. Both are the same run: one id, one status machine, one resume. A run that needs approval parks and tells you where to decide it.", "examples": [ { "command": "<%= config.bin %> connectors run --tool cxn_abc123/issues.list --args '{\"limit\":5}'", "description": "Call one tool by address." }, { "command": "<%= config.bin %> connectors run 'return await tools.linear.issues.list({limit: 5})'", "description": "Run a program that calls tools itself." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tool": { "name": "tool", "summary": "Tool address: `/`, or `/` when unambiguous.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "args": { "name": "args", "summary": "JSON object of tool arguments. Accepts @file or - for stdin.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "wait": { "helpGroup": "Execution", "name": "wait", "summary": "Seconds to hold the request waiting for a terminal status (default: the server's).", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "idempotency-key": { "helpGroup": "Execution", "name": "idempotency-key", "summary": "Retry with the same key to get the original run back instead of running it twice.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "deny-unattended": { "helpGroup": "Execution", "name": "deny-unattended", "summary": "Fail fast instead of parking when a call needs approval and nobody is watching.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "connectors:run", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Run a connector tool or a program.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "connectors", "run.js" ], "aliasPermutations": [], "permutations": [ "connectors:run", "run:connectors" ] }, "connectors:run:get": { "aliases": [], "args": { "run": { "description": "Run id, for example cxr_abc123.", "name": "run", "required": true } }, "description": "Read one run: its result, the problem document that explains a failure, or the approval it is parked on. This is how a `running` answer is polled.", "examples": [ { "command": "<%= config.bin %> connectors run get cxr_abc123", "description": "Check where a run got to." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "connectors:run:get", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Read one run.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "connectors", "run", "get.js" ], "aliasPermutations": [], "permutations": [ "connectors:run:get", "run:connectors:get", "run:get:connectors", "connectors:get:run", "get:connectors:run", "get:run:connectors" ] }, "connectors:run:list": { "aliases": [ "connectors:run:ls" ], "args": {}, "description": "List the team's runs, newest first. `--status awaiting_approval` is the approvals inbox.", "examples": [ { "command": "<%= config.bin %> connectors run list", "description": "List recent runs." }, { "command": "<%= config.bin %> connectors run list --status awaiting_approval", "description": "List the runs waiting on a decision." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "status": { "name": "status", "summary": "Show only runs in this state.", "hasDynamicHelp": false, "multiple": false, "options": [ "running", "awaiting_approval", "succeeded", "failed", "expired" ], "type": "option" }, "connection": { "name": "connection", "summary": "Show only runs that touched this connection.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "limit": { "name": "limit", "summary": "Maximum runs to return (default 50).", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "connectors:run:list", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List runs.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "connectors", "run", "list.js" ], "aliasPermutations": [ "connectors:run:ls", "run:connectors:ls", "run:ls:connectors", "connectors:ls:run", "ls:connectors:run", "ls:run:connectors" ], "permutations": [ "connectors:run:list", "run:connectors:list", "run:list:connectors", "connectors:list:run", "list:connectors:run", "list:run:connectors" ] }, "connectors:run:resume": { "aliases": [], "args": { "run": { "description": "Run id, for example cxr_abc123.", "name": "run", "required": true } }, "description": "Decide a run parked on an approval. A run parked for a person refuses a machine decision — omit the action there to read back what they decided.", "examples": [ { "command": "<%= config.bin %> connectors run resume cxr_abc123 --accept", "description": "Approve a parked call and let the run finish." }, { "command": "<%= config.bin %> connectors run resume cxr_abc123", "description": "Read back the decision a person already recorded." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "accept": { "name": "accept", "summary": "Approve the parked call.", "allowNo": false, "type": "boolean" }, "deny": { "name": "deny", "summary": "Refuse the parked call; the run reports the refusal.", "allowNo": false, "type": "boolean" }, "cancel": { "name": "cancel", "summary": "Abandon the run entirely.", "allowNo": false, "type": "boolean" }, "content": { "name": "content", "summary": "JSON object of values the paused call asked for. Accepts @file or - for stdin.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "connectors:run:resume", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Resume a parked run.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "connectors", "run", "resume.js" ], "aliasPermutations": [], "permutations": [ "connectors:run:resume", "run:connectors:resume", "run:resume:connectors", "connectors:resume:run", "resume:connectors:run", "resume:run:connectors" ] }, "connectors:unbind": { "aliases": [], "args": { "role": { "description": "Capsule connector role.", "name": "role", "required": true } }, "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "connectors:unbind", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Remove a capsule connector binding.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "connectors", "unbind.js" ], "aliasPermutations": [], "permutations": [ "connectors:unbind", "unbind:connectors" ], "examples": [ { "command": "<%= config.bin %> connectors unbind ", "description": "Remove a capsule connector binding." } ] }, "continue": { "aliases": [], "args": {}, "description": "Exchange a saved space key for a durable space API key once the space is claimed.", "examples": [ { "command": "<%= config.bin %> continue", "description": "Continue publishing to the claimed space saved in this directory." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "continue", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Continue publishing after claim.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "continue.js" ], "aliasPermutations": [], "permutations": [ "continue" ] }, "crons": { "aliases": [], "args": {}, "description": "Inspect and exercise a space's scheduled jobs.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "crons", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Manage scheduled jobs.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "crons.js" ], "aliasPermutations": [], "permutations": [ "crons" ], "examples": [ { "command": "<%= config.bin %> crons", "description": "Manage scheduled jobs." } ] }, "crons:ls": { "aliases": [ "crons:list" ], "args": {}, "description": "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.", "examples": [ { "command": "<%= config.bin %> crons ls --space docs", "description": "List scheduled jobs for the docs space." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "crons:ls", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List scheduled jobs.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "crons", "ls.js" ], "aliasPermutations": [ "crons:list", "list:crons" ], "permutations": [ "crons:ls", "ls:crons" ] }, "crons:run": { "aliases": [], "args": { "target": { "description": "Cron key or path, as shown by `sf crons ls`.", "name": "target", "required": true } }, "description": "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 '. Exits non-zero when the path answers 400 or worse.", "examples": [ { "command": "<%= config.bin %> crons run /api/digest", "description": "Request the path declared for the digest job." }, { "command": "<%= config.bin %> crons run api-digest --header \"authorization: Bearer $CRON_SECRET\"", "description": "Run a job whose handler checks the shared secret." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "header": { "name": "header", "summary": "Request header as 'name: value'. Repeat for multiple headers.", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "crons:run", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Run a scheduled job now.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "crons", "run.js" ], "aliasPermutations": [], "permutations": [ "crons:run", "run:crons" ] }, "db": { "aliases": [], "args": { "target": { "description": "Space ID, slug, live URL, or domain. Defaults to the linked space.", "name": "target", "required": false } }, "description": "Show the tables, columns, and pending migration plan of a space's database.", "examples": [ { "command": "<%= config.bin %> db", "description": "Inspect the linked space's database." }, { "command": "<%= config.bin %> db docs", "description": "Inspect space `docs`." }, { "command": "<%= config.bin %> db --port 4173", "description": "Inspect the database of a running `sf dev` server." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "local-url": { "helpGroup": "Runtime", "name": "local-url", "summary": "Read from a local `sf dev` server instead of the live version.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "port": { "helpGroup": "Runtime", "name": "port", "summary": "Local `sf dev` server port; shorthand for --local-url http://127.0.0.1:.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "db", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Inspect a space's database.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "db.js" ], "aliasPermutations": [], "permutations": [ "db" ] }, "db:console": { "aliases": [], "args": { "target": { "description": "Space ID, slug, live URL, or domain. Defaults to the linked space.", "name": "target", "required": false } }, "description": "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": [ { "command": "<%= config.bin %> db console", "description": "Open the console in a browser." }, { "command": "<%= config.bin %> db console --show-secret", "description": "Print the single-use console URL instead of opening it." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "show-secret": { "helpGroup": "Open", "name": "show-secret", "summary": "Print the single-use console URL instead of opening it.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "db:console", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Open a database console.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "db", "console.js" ], "aliasPermutations": [], "permutations": [ "db:console", "console:db" ] }, "db:dump": { "aliases": [], "args": { "target": { "description": "Space ID, slug, live URL, or domain. Defaults to the linked space.", "name": "target", "required": false } }, "description": "Print rows from a space's database, for debugging and export.", "examples": [ { "command": "<%= config.bin %> db dump", "description": "Dump every declared table." }, { "command": "<%= config.bin %> db dump --table todos --limit 100", "description": "Dump one table, up to 100 rows." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "local-url": { "helpGroup": "Runtime", "name": "local-url", "summary": "Read from a local `sf dev` server instead of the live version.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "port": { "helpGroup": "Runtime", "name": "port", "summary": "Local `sf dev` server port; shorthand for --local-url http://127.0.0.1:.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "table": { "helpGroup": "Runtime", "name": "table", "summary": "Restrict the dump to one table.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "limit": { "helpGroup": "Runtime", "name": "limit", "summary": "Maximum rows per table (default 25, max 100).", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "db:dump", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Dump database rows.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "db", "dump.js" ], "aliasPermutations": [], "permutations": [ "db:dump", "dump:db" ] }, "db:export": { "aliases": [], "args": { "target": { "description": "Space ID, slug, live URL, or domain. Defaults to the linked space.", "name": "target", "required": false } }, "description": "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": [ { "command": "<%= config.bin %> db export", "description": "Export the linked space." }, { "command": "<%= config.bin %> db export docs --out ./docs-backup.json", "description": "Export a selected space to a named file." }, { "command": "<%= config.bin %> db export --port 4173", "description": "Export a running local Zero capsule." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "local-url": { "helpGroup": "Runtime", "name": "local-url", "summary": "Read from a local `sf dev` server instead of the live version.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "port": { "helpGroup": "Runtime", "name": "port", "summary": "Local `sf dev` server port; shorthand for --local-url http://127.0.0.1:.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "out": { "helpGroup": "Output", "name": "out", "summary": "Backup file path (default spacefast-backup--.json).", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "db:export", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Export a complete database backup.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "db", "export.js" ], "aliasPermutations": [], "permutations": [ "db:export", "export:db" ] }, "db:migrate": { "aliases": [], "args": { "source": { "default": ".", "description": "Capsule source directory.", "name": "source" } }, "description": "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": [ { "command": "<%= config.bin %> db migrate", "description": "Re-apply the live capsule's migration plan." }, { "command": "<%= config.bin %> db migrate --drop", "description": "Allow destructive operations in the plan computed from this source tree." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "previous-artifact": { "helpGroup": "Runtime", "name": "previous-artifact", "summary": "Diff against this artifact or finalize payload instead of the live schema.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "drop": { "exclusive": [ "rename" ], "helpGroup": "Runtime", "name": "drop", "summary": "Allow the planned migration to include explicit drop operations.", "allowNo": false, "type": "boolean" }, "rename": { "exclusive": [ "drop" ], "helpGroup": "Runtime", "name": "rename", "summary": "Allow the planned migration to include explicit rename operations.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "db:migrate", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Apply database schema migrations.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "db", "migrate.js" ], "aliasPermutations": [], "permutations": [ "db:migrate", "migrate:db" ] }, "design": { "aliases": [], "args": {}, "description": "Generate committed presentation files (theme.json and _layout.html) from an authoring-time DESIGN.md.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "design", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Generate design files from DESIGN.md.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "design.js" ], "aliasPermutations": [], "permutations": [ "design" ], "examples": [ { "command": "<%= config.bin %> design", "description": "Generate design files from DESIGN.md." } ] }, "design:generate": { "aliases": [], "args": {}, "description": "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": [ { "command": "<%= config.bin %> design generate", "description": "Generate theme.json/_layout.html from DESIGN.md in the current directory." }, { "command": "<%= config.bin %> design generate --force", "description": "Regenerate, overwriting any existing theme.json/_layout.html." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "force": { "char": "f", "helpGroup": "Execution", "name": "force", "summary": "Overwrite existing generated files.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "design:generate", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Generate theme and layout files from DESIGN.md.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "design", "generate.js" ], "aliasPermutations": [], "permutations": [ "design:generate", "generate:design" ] }, "dev": { "aliases": [], "args": {}, "description": "Run this project locally. A zero runtime starts the capsule dev server; anything else previews Pages with sample data and the publish-time expander.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "port": { "char": "p", "name": "port", "summary": "Preview port.", "default": 4173, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "dir": { "char": "d", "name": "dir", "summary": "Project directory.", "default": ".", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "host": { "helpGroup": "Runtime", "name": "host", "summary": "Host interface for the local dev server.", "default": "127.0.0.1", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "allow-network": { "helpGroup": "Runtime", "name": "allow-network", "summary": "Allow an explicit non-loopback runtime dev-server binding.", "allowNo": false, "type": "boolean" }, "state-backend": { "helpGroup": "Runtime", "name": "state-backend", "summary": "Local state adapter for a runtime dev server.", "default": "memory", "hasDynamicHelp": false, "multiple": false, "options": [ "memory", "sqlite" ], "type": "option" }, "watch": { "helpGroup": "Runtime", "name": "watch", "summary": "Poll source files and reload the runtime after changes.", "allowNo": true, "type": "boolean" }, "watch-interval": { "helpGroup": "Runtime", "name": "watch-interval", "summary": "Source polling interval in milliseconds.", "default": 1000, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "dry-run": { "helpGroup": "Runtime", "name": "dry-run", "summary": "Print the dev server plan without starting it.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "dev", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Start the local dev server.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "dev.js" ], "aliasPermutations": [], "permutations": [ "dev" ], "examples": [ { "command": "<%= config.bin %> dev", "description": "Start the local dev server." } ] }, "docs": { "aliases": [], "args": { "query": { "description": "Search terms, or an exact topic slug to print (e.g. `publish`).", "name": "query", "required": false } }, "description": "Search the bundled docs offline: guides, CLI, API reference, and recipes. An exact topic slug prints that page.", "examples": [ { "command": "<%= config.bin %> docs", "description": "List the essential docs." }, { "command": "<%= config.bin %> docs rollback", "description": "Search docs for `rollback`." }, { "command": "<%= config.bin %> docs publishing", "description": "Print the `publishing` topic." }, { "command": "<%= config.bin %> docs domains --full", "description": "Search across the full docs set." }, { "command": "<%= config.bin %> docs --all --json", "description": "Every doc as machine-readable JSON." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "full": { "helpGroup": "Disclosure", "name": "full", "summary": "Include full-tier docs (everything but advanced reference).", "allowNo": false, "type": "boolean" }, "all": { "helpGroup": "Disclosure", "name": "all", "summary": "Include every doc, reference tier included.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "docs", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": false, "summary": "Search the bundled docs (offline).", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "rootHelpOrder": 7, "isESM": true, "relativePath": [ "dist", "commands", "docs.js" ], "aliasPermutations": [], "permutations": [ "docs" ] }, "doctor": { "aliases": [], "args": {}, "description": "Check local CLI state, auth, API reachability, and space selection for the current directory.", "examples": [ { "command": "<%= config.bin %> doctor", "description": "Diagnose CLI state, auth, and API reachability." }, { "command": "<%= config.bin %> doctor --space docs", "description": "Also check the health of a specific space." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "doctor", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Diagnose Spacefast CLI setup.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "doctor.js" ], "aliasPermutations": [], "permutations": [ "doctor" ] }, "domains": { "aliases": [], "args": {}, "description": "Manage space domains.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "domains", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Manage domains.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "domains.js" ], "aliasPermutations": [], "permutations": [ "domains" ], "examples": [ { "command": "<%= config.bin %> domains", "description": "Manage domains." } ] }, "domains:add": { "aliases": [ "domains:create" ], "args": { "hostname": { "description": "Hostname to attach.", "name": "hostname", "required": true } }, "description": "Create a domain in the space team, attach it to the space, and queue a DNS check.", "examples": [ { "command": "<%= config.bin %> domains add example.com --space docs", "description": "Attach a domain to a space." }, { "command": "<%= config.bin %> domains add example.com --space docs --role primary", "description": "Attach a domain and make it the space's primary address." }, { "command": "<%= config.bin %> domains add www.example.com --space docs --role redirect --redirect-to example.com", "description": "Attach a redirect domain." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "wait": { "helpGroup": "Execution", "name": "wait", "summary": "Wait until queued work finishes before returning.", "allowNo": true, "type": "boolean" }, "wait-timeout": { "helpGroup": "Execution", "name": "wait-timeout", "summary": "Seconds to wait for queued work to finish before giving up.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "redirect-to": { "dependsOn": [ "role" ], "helpGroup": "Domain behavior", "name": "redirect-to", "summary": "Destination for redirect domains.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "redirect-status": { "dependsOn": [ "role" ], "helpGroup": "Domain behavior", "name": "redirect-status", "summary": "HTTP status for redirect domains.", "hasDynamicHelp": false, "multiple": false, "options": [ "301", "302", "307", "308" ], "type": "option" }, "role": { "helpGroup": "Domain behavior", "name": "role", "summary": "How the domain should behave; primary makes it the space's main address.", "hasDynamicHelp": false, "multiple": false, "options": [ "standard", "primary", "redirect" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "domains:add", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Attach a domain.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "domains", "add.js" ], "aliasPermutations": [ "domains:create", "create:domains" ], "permutations": [ "domains:add", "add:domains" ] }, "domains:check": { "aliases": [], "args": { "domain": { "description": "Domain ID or hostname.", "name": "domain", "required": true } }, "description": "Queue a DNS/provider readiness check for an attached domain.", "examples": [ { "command": "<%= config.bin %> domains check example.com --space docs", "description": "Queue a DNS readiness check for a domain." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "wait": { "helpGroup": "Execution", "name": "wait", "summary": "Wait until queued work finishes before returning.", "allowNo": true, "type": "boolean" }, "wait-timeout": { "helpGroup": "Execution", "name": "wait-timeout", "summary": "Seconds to wait for queued work to finish before giving up.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "domains:check", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Check a domain.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "domains", "check.js" ], "aliasPermutations": [], "permutations": [ "domains:check", "check:domains" ] }, "domains:diagnostics": { "aliases": [], "args": { "domain": { "description": "Domain ID or hostname.", "name": "domain", "required": true } }, "description": "Read live DNS and SSL diagnostics for an attached domain.", "examples": [ "<%= config.bin %> domains diagnostics app.example.com --space docs" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "domains:diagnostics", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Inspect domain diagnostics.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "domains", "diagnostics.js" ], "aliasPermutations": [], "permutations": [ "domains:diagnostics", "diagnostics:domains" ] }, "domains:dns": { "aliases": [], "args": {}, "description": "Manage DNS records for a domain zone. See `domains dns ls`, `capabilities`, `refresh`, `add`, `update`, `rm`, `batch`, and `export`.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "domains:dns", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Manage domain DNS records.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "domains", "dns.js" ], "aliasPermutations": [], "permutations": [ "domains:dns", "dns:domains" ], "examples": [ { "command": "<%= config.bin %> domains dns", "description": "Manage domain DNS records." } ] }, "domains:dns:add": { "aliases": [ "domains:dns:create" ], "args": { "domain": { "description": "Domain ID or hostname.", "name": "domain", "required": true } }, "description": "Add a DNS record to the domain's Spacefast-managed zone.", "examples": [ "<%= config.bin %> domains dns add example.com --type MX --name @ --value mail.example.com --priority 10" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "type": { "name": "type", "summary": "Record type.", "hasDynamicHelp": false, "multiple": false, "options": [ "A", "AAAA", "ALIAS", "CAA", "CNAME", "MX", "NS", "SRV", "TXT" ], "type": "option" }, "name": { "name": "name", "summary": "Record name relative to the zone, or @ for the apex.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "value": { "name": "value", "summary": "Record value.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "ttl": { "name": "ttl", "summary": "Time to live in seconds (default 3600).", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "priority": { "name": "priority", "summary": "Priority for MX and SRV records.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "domains:dns:add", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Add a DNS record.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "domains", "dns", "add.js" ], "aliasPermutations": [ "domains:dns:create", "dns:domains:create", "dns:create:domains", "domains:create:dns", "create:domains:dns", "create:dns:domains" ], "permutations": [ "domains:dns:add", "dns:domains:add", "dns:add:domains", "domains:add:dns", "add:domains:dns", "add:dns:domains" ] }, "domains:dns:batch": { "aliases": [], "args": { "domain": { "description": "Domain ID or hostname.", "name": "domain", "required": true } }, "description": "Apply a batch of DNS changes in one call. The JSON body holds delete/patch/put/post arrays of records.", "examples": [ "<%= config.bin %> domains dns batch example.com --input @dns-changes.json", "<%= config.bin %> domains dns batch example.com --input '{\"posts\":[{\"type\":\"TXT\",\"name\":\"@\",\"value\":\"v=spf1 -all\"}]}'" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "input": { "char": "i", "name": "input", "required": true, "summary": "JSON batch body: a literal string, @file, or - for stdin.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "domains:dns:batch", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Apply a DNS record batch.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "domains", "dns", "batch.js" ], "aliasPermutations": [], "permutations": [ "domains:dns:batch", "dns:domains:batch", "dns:batch:domains", "domains:batch:dns", "batch:domains:dns", "batch:dns:domains" ] }, "domains:dns:capabilities": { "aliases": [], "args": { "domain": { "description": "Domain ID or hostname.", "name": "domain", "required": true } }, "description": "Show DNS provider capabilities for a domain.", "examples": [ "<%= config.bin %> domains dns capabilities example.com" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "domains:dns:capabilities", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Show DNS capabilities.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "domains", "dns", "capabilities.js" ], "aliasPermutations": [], "permutations": [ "domains:dns:capabilities", "dns:domains:capabilities", "dns:capabilities:domains", "domains:capabilities:dns", "capabilities:domains:dns", "capabilities:dns:domains" ] }, "domains:dns:export": { "aliases": [], "args": { "domain": { "description": "Domain ID or hostname.", "name": "domain", "required": true } }, "description": "Print the domain's zone as BIND-style records.", "examples": [ { "command": "<%= config.bin %> domains dns export example.com", "description": "Print the domain zone as BIND-style records." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "domains:dns:export", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Export the DNS zone.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "domains", "dns", "export.js" ], "aliasPermutations": [], "permutations": [ "domains:dns:export", "dns:domains:export", "dns:export:domains", "domains:export:dns", "export:domains:dns", "export:dns:domains" ] }, "domains:dns:ls": { "aliases": [ "domains:dns:list" ], "args": { "domain": { "description": "Domain ID or hostname.", "name": "domain", "required": true } }, "description": "List DNS records in the domain's Spacefast-managed zone.", "examples": [ { "command": "<%= config.bin %> domains dns ls example.com", "description": "List DNS records in the managed zone." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "limit": { "name": "limit", "summary": "Maximum number of records to return (default 200, max 500).", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "cursor": { "name": "cursor", "summary": "Pagination cursor from a previous response.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "domains:dns:ls", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List DNS records.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "domains", "dns", "ls.js" ], "aliasPermutations": [ "domains:dns:list", "dns:domains:list", "dns:list:domains", "domains:list:dns", "list:domains:dns", "list:dns:domains" ], "permutations": [ "domains:dns:ls", "dns:domains:ls", "dns:ls:domains", "domains:ls:dns", "ls:domains:dns", "ls:dns:domains" ] }, "domains:dns:refresh": { "aliases": [], "args": { "domain": { "description": "Domain ID or hostname.", "name": "domain", "required": true } }, "description": "Refresh a connected DNS provider snapshot for a domain.", "examples": [ { "command": "<%= config.bin %> domains dns refresh example.com", "description": "Refresh the connected DNS provider snapshot." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "domains:dns:refresh", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Refresh DNS provider snapshot.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "domains", "dns", "refresh.js" ], "aliasPermutations": [], "permutations": [ "domains:dns:refresh", "dns:domains:refresh", "dns:refresh:domains", "domains:refresh:dns", "refresh:domains:dns", "refresh:dns:domains" ] }, "domains:dns:rm": { "aliases": [ "domains:dns:remove", "domains:dns:delete" ], "args": { "domain": { "description": "Domain ID or hostname.", "name": "domain", "required": true }, "record": { "description": "DNS record ID.", "name": "record", "required": true } }, "description": "Delete a DNS record from the domain's zone.", "examples": [ { "command": "<%= config.bin %> domains dns rm example.com rec_123", "description": "Delete a DNS record from the zone." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "domains:dns:rm", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Delete a DNS record.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "domains", "dns", "rm.js" ], "aliasPermutations": [ "domains:dns:remove", "dns:domains:remove", "dns:remove:domains", "domains:remove:dns", "remove:domains:dns", "remove:dns:domains", "domains:dns:delete", "dns:domains:delete", "dns:delete:domains", "domains:delete:dns", "delete:domains:dns", "delete:dns:domains" ], "permutations": [ "domains:dns:rm", "dns:domains:rm", "dns:rm:domains", "domains:rm:dns", "rm:domains:dns", "rm:dns:domains" ] }, "domains:dns:update": { "aliases": [], "args": { "domain": { "description": "Domain ID or hostname.", "name": "domain", "required": true }, "record": { "description": "DNS record ID.", "name": "record", "required": true } }, "description": "Update fields on an existing DNS record.", "examples": [ { "command": "<%= config.bin %> domains dns update example.com rec_123 --value 1.2.3.4 --ttl 3600", "description": "Update a DNS record's value and TTL." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "type": { "name": "type", "summary": "Record type.", "hasDynamicHelp": false, "multiple": false, "options": [ "A", "AAAA", "ALIAS", "CAA", "CNAME", "MX", "NS", "SRV", "TXT" ], "type": "option" }, "name": { "name": "name", "summary": "Record name relative to the zone, or @ for the apex.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "value": { "name": "value", "summary": "Record value.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "ttl": { "name": "ttl", "summary": "Time to live in seconds (default 3600).", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "priority": { "name": "priority", "summary": "Priority for MX and SRV records.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "domains:dns:update", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Update a DNS record.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "domains", "dns", "update.js" ], "aliasPermutations": [], "permutations": [ "domains:dns:update", "dns:domains:update", "dns:update:domains", "domains:update:dns", "update:domains:dns", "update:dns:domains" ] }, "domains:ls": { "aliases": [ "domains:list" ], "args": {}, "description": "List domains attached to a space.", "examples": [ "<%= config.bin %> domains ls --space docs" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "domains:ls", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List space domains.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "domains", "ls.js" ], "aliasPermutations": [ "domains:list", "list:domains" ], "permutations": [ "domains:ls", "ls:domains" ] }, "domains:nameservers": { "aliases": [], "args": { "domain": { "description": "Domain ID or hostname.", "name": "domain", "required": true } }, "description": "Show the DNS mode and nameserver set for a domain.", "examples": [ { "command": "<%= config.bin %> domains nameservers example.com", "description": "Show the DNS mode and nameservers for a domain." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "domains:nameservers", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Show domain nameservers.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "domains", "nameservers.js" ], "aliasPermutations": [], "permutations": [ "domains:nameservers", "nameservers:domains" ] }, "domains:nameservers:set": { "aliases": [], "args": { "domain": { "description": "Domain ID or hostname.", "name": "domain", "required": true }, "nameservers": { "description": "Comma-separated nameservers (at least two).", "name": "nameservers", "required": true } }, "description": "Set custom nameservers for a Spacefast-registered domain. Externally registered domains change nameservers at their registrar.", "examples": [ "<%= config.bin %> domains nameservers set example.com ns1.example-dns.com,ns2.example-dns.com" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "domains:nameservers:set", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Set domain nameservers.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "domains", "nameservers", "set.js" ], "aliasPermutations": [], "permutations": [ "domains:nameservers:set", "nameservers:domains:set", "nameservers:set:domains", "domains:set:nameservers", "set:domains:nameservers", "set:nameservers:domains" ] }, "domains:rm": { "aliases": [ "domains:remove", "domains:delete" ], "args": { "domain": { "description": "Domain ID or hostname.", "name": "domain", "required": true } }, "description": "Remove a domain assignment from a space.", "examples": [ { "command": "<%= config.bin %> domains rm example.com --space docs", "description": "Remove a domain from a space after confirmation." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "wait": { "helpGroup": "Execution", "name": "wait", "summary": "Wait until queued work finishes before returning.", "allowNo": true, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "domains:rm", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Remove a domain.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "domains", "rm.js" ], "aliasPermutations": [ "domains:remove", "remove:domains", "domains:delete", "delete:domains" ], "permutations": [ "domains:rm", "rm:domains" ] }, "domains:search": { "aliases": [], "args": { "query": { "description": "Brand, idea, or full domain to search.", "name": "query", "required": false } }, "description": "Search domain ideas locally, with optional live availability checks in interactive mode.", "examples": [ { "command": "<%= config.bin %> domains search acme", "description": "Print local domain name ideas for a brand." }, { "command": "<%= config.bin %> domains search acme --interactive", "description": "Open the interactive domain search with live availability." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "interactive": { "name": "interactive", "summary": "Open the interactive terminal domain search UI.", "allowNo": false, "type": "boolean" }, "limit": { "name": "limit", "summary": "Number of local suggestions to print when not interactive.", "default": 20, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "domains:search", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Search domain names.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "domains", "search.js" ], "aliasPermutations": [], "permutations": [ "domains:search", "search:domains" ] }, "env": { "aliases": [], "args": {}, "description": "Manage space environment variables.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "env", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Manage env vars.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "env.js" ], "aliasPermutations": [], "permutations": [ "env" ], "examples": [ { "command": "<%= config.bin %> env", "description": "Manage env vars." } ] }, "env:export-template": { "aliases": [], "args": { "dir": { "description": "Project directory to inspect. Defaults to the current directory.", "name": "dir", "required": false } }, "description": "Read platform config files and print a dotenv template for variables to import into Spacefast.", "examples": [ { "command": "<%= config.bin %> env export-template", "description": "Print a dotenv import template from platform config in the current directory." }, { "command": "<%= config.bin %> env export-template ./app --format json", "description": "Emit the import template as JSON." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "format": { "name": "format", "summary": "Output format.", "default": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "env", "json" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "env:export-template", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Create a dotenv import template from platform config.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "env", "export-template.js" ], "aliasPermutations": [], "permutations": [ "env:export-template", "export-template:env" ] }, "env:import": { "aliases": [], "args": { "file": { "description": ".env file to import.", "name": "file", "required": true } }, "description": "Import variables from a dotenv file. Values are sent to the API and are not printed back.", "examples": [ { "command": "<%= config.bin %> env import .env --space docs", "description": "Import write-only variables from a .env file." }, { "command": "<%= config.bin %> env import public.env --space docs --no-secret", "description": "Explicitly import readable ordinary values." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "secret": { "name": "secret", "summary": "Keep imported values write-only. New values default write-only; updates preserve existing classifications.", "allowNo": true, "type": "boolean" }, "production": { "name": "production", "summary": "Also store each imported value for production builds.", "allowNo": false, "type": "boolean" }, "preview": { "name": "preview", "summary": "Also store each imported value for preview builds.", "allowNo": false, "type": "boolean" }, "branch": { "name": "branch", "summary": "Also store each imported value for an exact branch. Repeat for multiple branches.", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "from": { "name": "from", "summary": "Platform export format to import. Vercel, Netlify, and Cloudflare use dotenv exports.", "default": "dotenv", "hasDynamicHelp": false, "multiple": false, "options": [ "dotenv", "vercel", "netlify", "cloudflare" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "env:import", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Import variables from a .env file.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "env", "import.js" ], "aliasPermutations": [], "permutations": [ "env:import", "import:env" ] }, "env:ls": { "aliases": [ "env:list" ], "args": {}, "description": "List space variables.", "examples": [ { "command": "<%= config.bin %> env ls --space docs", "description": "List space variables (values masked)." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "show-values": { "name": "show-values", "summary": "Print plaintext variable values.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "env:ls", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List space variables.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "env", "ls.js" ], "aliasPermutations": [ "env:list", "list:env" ], "permutations": [ "env:ls", "ls:env" ] }, "env:pull": { "aliases": [], "args": { "file": { "description": "File to write the pulled variables to. Defaults to .env.local.", "name": "file", "required": false } }, "description": "Pull effective space and shared variables into a local env file (default .env.local). Refuses to overwrite an existing file unless --force.", "examples": [ { "command": "<%= config.bin %> env pull --space docs", "description": "Write variables to .env.local." }, { "command": "<%= config.bin %> env pull .env.development --space docs --force", "description": "Write variables to .env.development, replacing an existing file." }, { "command": "<%= config.bin %> env pull --space docs --stdout > .env", "description": "Print variables in .env format to stdout." }, { "command": "<%= config.bin %> env pull --space docs --stdout --format json", "description": "Print variables as JSON." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "format": { "name": "format", "summary": "Output format.", "default": "env", "hasDynamicHelp": false, "multiple": false, "options": [ "env", "json" ], "type": "option" }, "force": { "name": "force", "summary": "Overwrite the target file if it already exists.", "allowNo": false, "type": "boolean" }, "stdout": { "name": "stdout", "summary": "Print variables to stdout instead of writing a file.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "env:pull", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Pull variables.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "env", "pull.js" ], "aliasPermutations": [], "permutations": [ "env:pull", "pull:env" ] }, "env:rm": { "aliases": [ "env:remove", "env:delete" ], "args": { "name": { "description": "Variable name.", "name": "name", "required": true } }, "description": "Delete a space variable.", "examples": [ { "command": "<%= config.bin %> env rm API_URL --space docs", "description": "Delete a space variable after confirmation." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "env:rm", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Delete a space variable.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "env", "rm.js" ], "aliasPermutations": [ "env:remove", "remove:env", "env:delete", "delete:env" ], "permutations": [ "env:rm", "rm:env" ] }, "env:set": { "aliases": [], "args": { "name": { "description": "Variable name.", "name": "name", "required": true }, "value": { "description": "Variable value. Omit it and pass --value-from-stdin for secrets.", "name": "value", "required": false } }, "description": "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": [ { "command": "printf %s \"$API_TOKEN\" | <%= config.bin %> env set API_TOKEN --value-from-stdin --space docs", "description": "Set a write-only space variable without putting it in the command line." }, { "command": "<%= config.bin %> env set PUBLIC_ORIGIN https://www.example.com --no-secret --space docs", "description": "Explicitly set a readable ordinary value." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "value-from-stdin": { "name": "value-from-stdin", "summary": "Read the value from standard input, keeping it out of your shell history and process list.", "allowNo": false, "type": "boolean" }, "secret": { "name": "secret", "summary": "Keep the value write-only. New values default write-only; updates preserve the existing classification.", "allowNo": true, "type": "boolean" }, "production-value": { "helpGroup": "Build", "name": "production-value", "summary": "Value to inject for production builds.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "preview-value": { "helpGroup": "Build", "name": "preview-value", "summary": "Value to inject for preview builds.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "branch-value": { "helpGroup": "Build", "name": "branch-value", "summary": "Value to inject for a branch build, formatted as branch=value. Repeat for multiple branches.", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "env:set", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Set a space variable.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "env", "set.js" ], "aliasPermutations": [], "permutations": [ "env:set", "set:env" ] }, "feedback": { "aliases": [], "args": {}, "description": "Send feedback to Spacefast with optional error, request, space, or URL context.", "examples": [ { "command": "<%= config.bin %> feedback -m \"The continuation docs are unclear\" --category docs", "description": "Send docs feedback." }, { "command": "<%= config.bin %> feedback -m \"Publish failed after claim\" --category bug --error-code space_claimed_credential_available --request-id req_123 --json", "description": "Send machine-readable feedback with error context." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "message": { "char": "m", "name": "message", "required": true, "summary": "Feedback message.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "category": { "name": "category", "summary": "Feedback category.", "default": "other", "hasDynamicHelp": false, "multiple": false, "options": [ "bug", "docs", "limit", "idea", "other" ], "type": "option" }, "error-code": { "name": "error-code", "summary": "Related API error code.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "request-id": { "name": "request-id", "summary": "Related API request id.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space-id": { "name": "space-id", "summary": "Related space id.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "url": { "name": "url", "summary": "Related URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "feedback", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Send feedback to Spacefast.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "rootHelpOrder": 8, "isESM": true, "relativePath": [ "dist", "commands", "feedback.js" ], "aliasPermutations": [], "permutations": [ "feedback" ] }, "fetch": { "aliases": [], "args": { "path": { "description": "Canonical route to fetch. Defaults to /.", "name": "path", "required": false } }, "description": "Fetch private Space content through the same central exchange and host-only cookie flow as a browser.", "examples": [ { "command": "<%= config.bin %> fetch /docs --output ./docs.html", "description": "Fetch /docs from the linked Space." }, { "command": "<%= config.bin %> fetch / --status --headers --json", "description": "Inspect an authenticated response without writing its body." }, { "command": "<%= config.bin %> fetch / --verify ver_123 --json", "description": "Verify that a private route serves an exact published version." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "headers": { "helpGroup": "Verification", "name": "headers", "summary": "Include response headers, excluding credential-bearing headers.", "allowNo": false, "type": "boolean" }, "output": { "helpGroup": "Output", "name": "output", "summary": "File to write the response body into.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "status": { "helpGroup": "Verification", "name": "status", "summary": "Report the HTTP status without requiring a body output file.", "allowNo": false, "type": "boolean" }, "verify": { "helpGroup": "Verification", "name": "verify", "summary": "Require a successful response serving this exact version ID.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "fetch", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Fetch private content.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "fetch.js" ], "aliasPermutations": [], "permutations": [ "fetch" ] }, "functions": { "aliases": [], "args": {}, "description": "Publish a Worker with sf publish. env.CONNECTORS.call(role, tool, args) calls a connector role; env.CONNECTORS.tracker.issues.create(args) is the role proxy. The Space must have bindings or its capsule must declare roles. When the version includes a capsule, env.ZERO.query(name, ...args) and env.ZERO.mutate(name, ...args) call it. Both bindings forward the request's signed Zero identity cookie. ZERO uses the Space's service principal when no visitor is signed in.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "functions", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Use Workers with Spacefast bindings.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "functions.js" ], "aliasPermutations": [], "permutations": [ "functions" ], "examples": [ { "command": "<%= config.bin %> functions", "description": "Use Workers with Spacefast bindings." } ] }, "git": { "aliases": [], "args": {}, "description": "Manage repository connections and Git push deploys.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "git", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Manage repository connections.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "git.js" ], "aliasPermutations": [], "permutations": [ "git" ], "examples": [ { "command": "<%= config.bin %> git", "description": "Manage repository connections." } ] }, "git:build": { "aliases": [], "args": {}, "description": "Trigger a generic remote build from a repository connection.", "examples": [ { "command": "<%= config.bin %> git build --space docs --ref main", "description": "Trigger a remote build from the main ref." }, { "command": "<%= config.bin %> git build --space docs --branch preview --target preview --wait", "description": "Build a preview branch and wait for it to finish." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "connection-type": { "helpGroup": "Repository", "name": "connection-type", "summary": "Repository connection type.", "default": "connected", "hasDynamicHelp": false, "multiple": false, "options": [ "connected", "hosted" ], "type": "option" }, "ref": { "env": "SPACEFAST_BUILD_REF", "helpGroup": "Build", "name": "ref", "summary": "Repository ref, branch, tag, or commit to build.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "branch": { "env": "SPACEFAST_GIT_BRANCH", "helpGroup": "Build", "name": "branch", "summary": "Branch name for preview alias and production branch selection.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "commit": { "env": "SPACEFAST_GIT_COMMIT", "helpGroup": "Build", "name": "commit", "summary": "Commit SHA to build.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "pull-request": { "env": "SPACEFAST_PULL_REQUEST", "helpGroup": "Build", "name": "pull-request", "summary": "Pull request number for preview builds.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "config": { "env": "SPACEFAST_CONFIG", "helpGroup": "Build", "name": "config", "summary": "Path to an sf.jsonc file with repository build settings.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target": { "helpGroup": "Build", "name": "target", "summary": "Force production or preview build target.", "hasDynamicHelp": false, "multiple": false, "options": [ "production", "preview" ], "type": "option" }, "root-directory": { "helpGroup": "Build", "name": "root-directory", "summary": "Override the saved app root directory for this build.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "install-directory": { "helpGroup": "Build", "name": "install-directory", "summary": "Override the saved dependency install directory for this build.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "install-command": { "helpGroup": "Build", "name": "install-command", "summary": "Override the saved install command for this build.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "build-command": { "helpGroup": "Build", "name": "build-command", "summary": "Override the saved build command for this build.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "output-directory": { "helpGroup": "Build", "name": "output-directory", "summary": "Override the saved build output directory for this build.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "ignored-build-command": { "helpGroup": "Build", "name": "ignored-build-command", "summary": "Override the saved ignored build command for this build.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "auto-finalize": { "helpGroup": "Execution", "name": "auto-finalize", "summary": "Finalize the remote build automatically after staging the build output.", "allowNo": true, "type": "boolean" }, "allow-unsupported-platform-features": { "helpGroup": "Migration", "name": "allow-unsupported-platform-features", "summary": "Allow unsupported Vercel or Cloudflare migration features for this build.", "allowNo": true, "type": "boolean" }, "wait": { "helpGroup": "Execution", "name": "wait", "summary": "Wait until queued work finishes before returning.", "allowNo": true, "type": "boolean" }, "wait-timeout": { "helpGroup": "Execution", "name": "wait-timeout", "summary": "Seconds to wait for the repository build to finish.", "default": 900, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "git:build", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Build repository source.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "git", "build.js" ], "aliasPermutations": [], "permutations": [ "git:build", "build:git" ] }, "git:connect": { "aliases": [], "args": {}, "description": "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": [ { "command": "<%= config.bin %> git connect --space docs --provider github --repository owner/repo", "description": "Connect a GitHub repository." }, { "command": "<%= config.bin %> git connect --space docs --provider github --repository owner/repo --installation-id 12345678", "description": "Pick the installation when more than one grants the repository." }, { "command": "<%= config.bin %> git connect --space docs --repository owner/repo --production-branch main --sync", "description": "Connect a repository, set the production branch, and sync." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "provider": { "helpGroup": "Repository", "name": "provider", "summary": "Repository host.", "hasDynamicHelp": false, "multiple": false, "options": [ "github", "gitlab", "bitbucket", "generic" ], "type": "option" }, "connection-type": { "helpGroup": "Repository", "name": "connection-type", "summary": "Repository connection type.", "default": "connected", "hasDynamicHelp": false, "multiple": false, "options": [ "connected", "hosted" ], "type": "option" }, "repository": { "helpGroup": "Repository", "name": "repository", "summary": "Repository full name, for example owner/repo. Defaults to the origin remote.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "repository-id": { "helpGroup": "Repository", "name": "repository-id", "summary": "Repository ID from the host. Resolved from GitHub when omitted.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "repository-name": { "helpGroup": "Repository", "name": "repository-name", "summary": "Repository name from the host.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "clone-url": { "helpGroup": "Repository", "name": "clone-url", "summary": "Clone URL when safe to expose.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "upstream-url": { "helpGroup": "Repository", "name": "upstream-url", "summary": "Upstream repository URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "detect-urls": { "helpGroup": "Repository", "name": "detect-urls", "summary": "Detect clone and upstream URLs from the origin remote.", "allowNo": true, "type": "boolean" }, "installation-id": { "env": "SPACEFAST_REPOSITORY_INSTALLATION_ID", "helpGroup": "Repository", "name": "installation-id", "summary": "GitHub App installation ID. Resolved from your installations when omitted; pass it to pick one when several grant the repository.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "credential": { "env": "SPACEFAST_REPOSITORY_CREDENTIAL", "helpGroup": "Repository", "name": "credential", "summary": "Generic Git clone token. Stored encrypted by the API.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "default-branch": { "helpGroup": "Repository", "name": "default-branch", "summary": "Repository default branch.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "production-branch": { "helpGroup": "Repository", "name": "production-branch", "summary": "Branch that publishes to production.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "ref": { "env": "SPACEFAST_BUILD_REF", "helpGroup": "Repository", "name": "ref", "summary": "Ref, branch, tag, or commit to sync or build after connecting.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "config": { "env": "SPACEFAST_CONFIG", "helpGroup": "Build", "name": "config", "summary": "Path to an sf.jsonc file with repository build settings.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "auto-deploy-production": { "helpGroup": "Automation", "name": "auto-deploy-production", "summary": "Automatically build pushes to the production branch.", "allowNo": true, "type": "boolean" }, "auto-deploy-previews": { "helpGroup": "Automation", "name": "auto-deploy-previews", "summary": "Automatically build preview branches and pull requests.", "allowNo": true, "type": "boolean" }, "root-directory": { "helpGroup": "Build", "name": "root-directory", "summary": "App root directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "install-directory": { "helpGroup": "Build", "name": "install-directory", "summary": "Dependency install directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "install-command": { "helpGroup": "Build", "name": "install-command", "summary": "Install command.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "build-command": { "helpGroup": "Build", "name": "build-command", "summary": "Build command.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "ignored-build-command": { "helpGroup": "Build", "name": "ignored-build-command", "summary": "Command that skips a build when it exits 0.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "output-directory": { "helpGroup": "Build", "name": "output-directory", "summary": "Build output directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "framework-preset": { "helpGroup": "Build", "name": "framework-preset", "summary": "Framework preset.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "platform-preset": { "helpGroup": "Build", "name": "platform-preset", "summary": "Imported platform preset.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "allow-unsupported-platform-features": { "helpGroup": "Migration", "name": "allow-unsupported-platform-features", "summary": "Allow unsupported migration features.", "allowNo": false, "type": "boolean" }, "apply-best": { "helpGroup": "Automation", "name": "apply-best", "summary": "Detect and save the highest-ranked build settings after connecting.", "allowNo": false, "type": "boolean" }, "sync": { "helpGroup": "Automation", "name": "sync", "summary": "Request repository sync after connecting.", "allowNo": false, "type": "boolean" }, "build-now": { "helpGroup": "Automation", "name": "build-now", "summary": "Queue a generic Build after connecting.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "git:connect", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Connect repository.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "git", "connect.js" ], "aliasPermutations": [], "permutations": [ "git:connect", "connect:git" ] }, "git:disconnect": { "aliases": [], "args": {}, "description": "Delete a repository connection.", "examples": [ { "command": "<%= config.bin %> git disconnect --space docs", "description": "Delete the repository connection." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "connection-type": { "helpGroup": "Repository", "name": "connection-type", "summary": "Repository connection type.", "default": "connected", "hasDynamicHelp": false, "multiple": false, "options": [ "connected", "hosted" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "git:disconnect", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Disconnect repository.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "git", "disconnect.js" ], "aliasPermutations": [], "permutations": [ "git:disconnect", "disconnect:git" ] }, "git:github": { "aliases": [], "args": {}, "description": "Inspect GitHub App installations and repositories.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "git:github", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Manage GitHub App setup.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "git", "github.js" ], "aliasPermutations": [], "permutations": [ "git:github", "github:git" ], "examples": [ { "command": "<%= config.bin %> git github", "description": "Manage GitHub App setup." } ] }, "git:github:installations": { "aliases": [], "args": {}, "description": "List GitHub App installations available to the current user.", "examples": [ { "command": "<%= config.bin %> git github installations", "description": "List GitHub App installations for the current user." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "git:github:installations", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List GitHub installations.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "git", "github", "installations.js" ], "aliasPermutations": [], "permutations": [ "git:github:installations", "github:git:installations", "github:installations:git", "git:installations:github", "installations:git:github", "installations:github:git" ] }, "git:github:repos": { "aliases": [], "args": { "installation": { "description": "GitHub App installation ID.", "name": "installation", "required": false } }, "description": "List repositories available to a GitHub App installation.", "examples": [ { "command": "<%= config.bin %> git github repos 12345678", "description": "List repositories for a GitHub App installation." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "git:github:repos", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List GitHub repositories.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "git", "github", "repos.js" ], "aliasPermutations": [], "permutations": [ "git:github:repos", "github:git:repos", "github:repos:git", "git:repos:github", "repos:git:github", "repos:github:git" ] }, "git:ls": { "aliases": [], "args": {}, "description": "Show a repository connection.", "examples": [ { "command": "<%= config.bin %> git ls --space docs", "description": "Show the repository connection." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "connection-type": { "helpGroup": "Repository", "name": "connection-type", "summary": "Repository connection type.", "default": "connected", "hasDynamicHelp": false, "multiple": false, "options": [ "connected", "hosted" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "git:ls", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Show repository connection.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "git", "ls.js" ], "aliasPermutations": [], "permutations": [ "git:ls", "ls:git" ] }, "git:origin": { "aliases": [], "args": {}, "description": "Install a signed Spacefast push remote for direct Git push deploys.", "examples": [ { "command": "<%= config.bin %> git origin", "description": "Add a signed `spacefast` remote when `origin` already points to your upstream." }, { "command": "<%= config.bin %> git origin --set-origin", "description": "Set `origin` to the signed Spacefast push remote." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "set-origin": { "helpGroup": "Git", "name": "set-origin", "summary": "Update origin instead of adding or updating the Spacefast remote.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "git:origin", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Install Spacefast git remote.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "git", "origin.js" ], "aliasPermutations": [], "permutations": [ "git:origin", "origin:git" ] }, "git:sync": { "aliases": [], "args": {}, "description": "Sync the upstream repository for this space.", "examples": [ { "command": "<%= config.bin %> git sync --space docs", "description": "Sync the upstream repository for the space." }, { "command": "<%= config.bin %> git sync --space docs --ref main", "description": "Sync a specific ref." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "connection-type": { "helpGroup": "Repository", "name": "connection-type", "summary": "Repository connection type.", "default": "connected", "hasDynamicHelp": false, "multiple": false, "options": [ "connected", "hosted" ], "type": "option" }, "ref": { "helpGroup": "Repository", "name": "ref", "summary": "Ref, branch, or tag to sync.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "ttl-seconds": { "helpGroup": "Repository", "name": "ttl-seconds", "summary": "Signed source remote TTL in seconds, up to 86400.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "read-only-ref": { "helpGroup": "Repository", "name": "read-only-ref", "summary": "Ref pattern to protect during repository sync. Repeat for multiple patterns.", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "git:sync", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Sync remote repository source.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "git", "sync.js" ], "aliasPermutations": [], "permutations": [ "git:sync", "sync:git" ] }, "git:update": { "aliases": [], "args": {}, "description": "Update a repository connection.", "examples": [ { "command": "<%= config.bin %> git update --space docs --production-branch main", "description": "Change the production branch on the repository connection." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "connection-type": { "helpGroup": "Repository", "name": "connection-type", "summary": "Repository connection type.", "default": "connected", "hasDynamicHelp": false, "multiple": false, "options": [ "connected", "hosted" ], "type": "option" }, "clone-url": { "helpGroup": "Repository", "name": "clone-url", "summary": "Clone URL when safe to expose.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "upstream-url": { "helpGroup": "Repository", "name": "upstream-url", "summary": "Upstream repository URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "production-branch": { "helpGroup": "Repository", "name": "production-branch", "summary": "Branch that publishes to production.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "credential": { "env": "SPACEFAST_REPOSITORY_CREDENTIAL", "helpGroup": "Repository", "name": "credential", "summary": "Generic Git clone token. Stored encrypted by the API.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "clear-credential": { "helpGroup": "Repository", "name": "clear-credential", "summary": "Clear the stored generic Git clone token.", "allowNo": false, "type": "boolean" }, "auto-deploy-production": { "helpGroup": "Automation", "name": "auto-deploy-production", "summary": "Automatically build pushes to the production branch.", "allowNo": true, "type": "boolean" }, "auto-deploy-previews": { "helpGroup": "Automation", "name": "auto-deploy-previews", "summary": "Automatically build preview branches and pull requests.", "allowNo": true, "type": "boolean" }, "config": { "env": "SPACEFAST_CONFIG", "helpGroup": "Build", "name": "config", "summary": "Path to an sf.jsonc file with repository build settings.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "root-directory": { "helpGroup": "Build", "name": "root-directory", "summary": "App root directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "install-directory": { "helpGroup": "Build", "name": "install-directory", "summary": "Dependency install directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "install-command": { "helpGroup": "Build", "name": "install-command", "summary": "Install command.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "build-command": { "helpGroup": "Build", "name": "build-command", "summary": "Build command.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "ignored-build-command": { "helpGroup": "Build", "name": "ignored-build-command", "summary": "Command that skips a build when it exits 0.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "output-directory": { "helpGroup": "Build", "name": "output-directory", "summary": "Build output directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "framework-preset": { "helpGroup": "Build", "name": "framework-preset", "summary": "Framework preset.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "platform-preset": { "helpGroup": "Build", "name": "platform-preset", "summary": "Imported platform preset.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "allow-unsupported-platform-features": { "helpGroup": "Migration", "name": "allow-unsupported-platform-features", "summary": "Allow unsupported migration features.", "allowNo": true, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "git:update", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Update repository connection.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "git", "update.js" ], "aliasPermutations": [], "permutations": [ "git:update", "update:git" ] }, "git:webhooks": { "aliases": [], "args": {}, "description": "Inspect repository webhook deliveries, queued builds, and ignored reasons.", "examples": [ { "command": "<%= config.bin %> git webhooks", "description": "List recent repository webhook deliveries for the current space." }, { "command": "<%= config.bin %> git webhooks --delivery rwd_123", "description": "Show one repository webhook delivery." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "delivery": { "helpGroup": "Repository", "name": "delivery", "summary": "Repository webhook delivery id to fetch.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "status": { "helpGroup": "Repository", "name": "status", "summary": "Filter deliveries by status.", "hasDynamicHelp": false, "multiple": false, "options": [ "received", "processing", "processed", "ignored", "failed" ], "type": "option" }, "connection-type": { "helpGroup": "Repository", "name": "connection-type", "summary": "Filter deliveries by repository connection type.", "hasDynamicHelp": false, "multiple": false, "options": [ "connected", "hosted" ], "type": "option" }, "limit": { "helpGroup": "Repository", "name": "limit", "summary": "Maximum number of deliveries to list.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "cursor": { "helpGroup": "Repository", "name": "cursor", "summary": "Pagination cursor from a previous list response.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "git:webhooks", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Inspect repository webhook deliveries.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "git", "webhooks.js" ], "aliasPermutations": [], "permutations": [ "git:webhooks", "webhooks:git" ] }, "init": { "aliases": [], "args": { "name": { "description": "Directory name for a new project. Omit to initialize the current directory.", "name": "name", "required": false } }, "description": "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": [ { "command": "<%= config.bin %> init", "description": "Write a starter sf.jsonc in the current directory." }, { "command": "<%= config.bin %> init my-site", "description": "Create a new project directory named my-site." }, { "command": "<%= config.bin %> init --space docs", "description": "Initialize config and link the current directory to space `docs`." }, { "command": "<%= config.bin %> init my-app --runtime zero --template guestbook", "description": "Scaffold a Zero capsule in a new directory." }, { "command": "<%= config.bin %> init --runtime functions", "description": "Scaffold a Functions worker in the current directory." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force": { "char": "f", "helpGroup": "Execution", "name": "force", "summary": "Overwrite existing generated files.", "allowNo": false, "type": "boolean" }, "runtime": { "helpGroup": "Project", "name": "runtime", "summary": "Project runtime to scaffold.", "default": "static", "hasDynamicHelp": false, "multiple": false, "options": [ "static", "zero", "functions" ], "type": "option" }, "template": { "helpGroup": "Zero", "name": "template", "summary": "Zero starter template to scaffold.", "hasDynamicHelp": false, "multiple": false, "options": [ "todo", "guestbook", "contact" ], "type": "option" }, "title": { "helpGroup": "Zero", "name": "title", "summary": "Zero starter app title.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-git": { "helpGroup": "Zero", "name": "no-git", "summary": "Skip initializing git for a Zero starter app.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "init", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Create a Spacefast project.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "rootHelpOrder": 6, "isESM": true, "relativePath": [ "dist", "commands", "init.js" ], "aliasPermutations": [], "permutations": [ "init" ] }, "inspect": { "aliases": [], "args": { "target": { "description": "Space ID, slug, live URL, or domain.", "name": "target", "required": false } }, "description": "Look up a space by ID, slug, live URL, or attached domain. Prints space details, live version, and runtime state.", "examples": [ { "command": "<%= config.bin %> inspect docs", "description": "Inspect by slug." }, { "command": "<%= config.bin %> inspect https://spacefast.com", "description": "Inspect by live URL." }, { "command": "<%= config.bin %> inspect spc_abc123 --team acme", "description": "Inspect by ID in a specific team." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "inspect", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Inspect a space by ID, slug, URL, or domain.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "inspect.js" ], "aliasPermutations": [], "permutations": [ "inspect" ] }, "link": { "aliases": [], "args": {}, "description": "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": [ { "command": "<%= config.bin %> link --space my-space", "description": "Link the current directory to a space by slug." }, { "command": "<%= config.bin %> link --space prj_abc123 --team acme", "description": "Link the current directory to a space by id in a specific team." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "link", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Link the current directory to a space.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "link.js" ], "aliasPermutations": [], "permutations": [ "link" ] }, "login": { "aliases": [ "auth:login" ], "args": {}, "description": "Log this machine in through the browser, or save an API key you already have.", "examples": [ { "command": "<%= config.bin %> login", "description": "Start browser-assisted device login." }, { "command": "<%= config.bin %> login --token st_...", "description": "Store a token for non-interactive use." }, { "command": "<%= config.bin %> login --access read", "description": "Ask for a read-only credential instead of full agent access." }, { "command": "printf '%s\\n' \"$HANDOFF_LINK\" | <%= config.bin %> login --handoff", "description": "Redeem a one-use dashboard handoff link through stdin." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "access": { "name": "access", "summary": "Access to request for this machine: read or agent. Defaults to agent. You confirm or narrow it in the browser.", "hasDynamicHelp": false, "multiple": false, "options": [ "read", "agent" ], "type": "option" }, "handoff": { "name": "handoff", "summary": "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.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "login", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Log in to Spacefast.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "rootHelpOrder": 5, "isESM": true, "relativePath": [ "dist", "commands", "login.js" ], "aliasPermutations": [ "auth:login", "login:auth" ], "permutations": [ "login" ] }, "logout": { "aliases": [], "args": {}, "description": "Delete the local login and revoke the CLI-minted token when possible.", "examples": [ { "command": "<%= config.bin %> logout", "description": "Log out and revoke the local CLI token." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "logout", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Log out of Spacefast.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "logout.js" ], "aliasPermutations": [], "permutations": [ "logout" ] }, "logs": { "aliases": [], "args": { "target": { "description": "Space ID, slug, live URL, or domain. Defaults to the linked space.", "name": "target", "required": false }, "kind": { "description": "Log kind: `access` for requests the edge served, `runtime` for what your code logged. Defaults to access.", "name": "kind", "required": false } }, "description": "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": [ { "command": "<%= config.bin %> logs", "description": "Recent requests for the linked space." }, { "command": "<%= config.bin %> logs runtime --follow", "description": "Keep pulling what your handlers log as it lands." }, { "command": "<%= config.bin %> logs docs runtime", "description": "What space `docs` logged from its own code." }, { "command": "<%= config.bin %> logs https://spacefast.com access", "description": "Requests served for a space by URL." }, { "command": "<%= config.bin %> logs runtime --request-id req_9f21", "description": "Everything one request logged." }, { "command": "<%= config.bin %> logs runtime --handler checkout", "description": "Only what the `checkout` handler logged." }, { "command": "<%= config.bin %> logs runtime --follow --json", "description": "Stream one JSON object per line, for piping into jq." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "limit": { "name": "limit", "summary": "Maximum number of log entries.", "default": 50, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "follow": { "char": "f", "name": "follow", "summary": "Poll for new log entries every 2 seconds until interrupted (Ctrl-C).", "allowNo": false, "type": "boolean" }, "cursor": { "name": "cursor", "summary": "Continue from the cursor printed by the previous page.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "request-id": { "name": "request-id", "summary": "Runtime logs only: everything logged while serving one request.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "handler": { "name": "handler", "summary": "Runtime logs only: lines from one Zero mutation or Functions handler.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "logs", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Read a space's request and handler logs.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "logs.js" ], "aliasPermutations": [], "permutations": [ "logs" ] }, "map": { "aliases": [], "args": {}, "description": "List the flat CLI command surface for agents and other programmatic callers.", "examples": [ { "command": "<%= config.bin %> map --json", "description": "Return canonical commands, aliases, and invocations as JSON." }, { "command": "<%= config.bin %> map --paths", "description": "Print one canonical command invocation per line." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "paths": { "name": "paths", "summary": "Print only canonical command invocations.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "map", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Print the machine-readable command map.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "map.js" ], "aliasPermutations": [], "permutations": [ "map" ] }, "mcp": { "aliases": [], "args": {}, "description": "Run the Spacefast On-Device MCP server over stdio for MCP clients.", "examples": [ "<%= config.bin %> mcp" ], "flags": { "api-url": { "env": "SPACEFAST_API_URL", "name": "api-url", "summary": "Spacefast API base URL for MCP tool calls.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "name": "token", "noCacheDefault": true, "summary": "Spacefast API token for MCP tool calls.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "workspace-root": { "env": "SPACEFAST_MCP_WORKSPACE_ROOT", "name": "workspace-root", "summary": "Root allowed for On-Device MCP path publishing.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "mcp", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Run the Spacefast MCP server.", "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "commands", "mcp.js" ], "aliasPermutations": [], "permutations": [ "mcp" ] }, "mcp:install": { "aliases": [], "args": {}, "description": "Install Spacefast MCP config into detected or selected coding agents.", "examples": [ { "command": "<%= config.bin %> mcp install --agent claude-code", "description": "Install hosted MCP through the signed-in Spacefast proxy." }, { "command": "<%= config.bin %> mcp install --agent cursor --remote --oauth", "description": "Install direct hosted MCP with editor-managed OAuth for Cursor." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "agent": { "name": "agent", "summary": "Agent/client to configure. Repeat to configure more than one.", "hasDynamicHelp": false, "multiple": true, "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" ], "type": "option" }, "remote": { "name": "remote", "summary": "Use hosted MCP through `sf mcp proxy` and the current CLI login.", "allowNo": false, "type": "boolean" }, "local": { "exclusive": [ "remote", "oauth" ], "name": "local", "summary": "Use checkout-aware local stdio MCP instead of the hosted proxy.", "allowNo": false, "type": "boolean" }, "oauth": { "dependsOn": [ "remote" ], "name": "oauth", "summary": "With --remote, connect directly and let the editor handle OAuth.", "allowNo": false, "type": "boolean" }, "endpoint": { "hidden": true, "name": "endpoint", "summary": "Hosted or On-Device MCP endpoint URL override.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "resource": { "hidden": true, "name": "resource", "summary": "OAuth resource identifier for hosted MCP.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "server-name": { "hidden": true, "name": "server-name", "summary": "MCP server name in generated config.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "command": { "hidden": true, "name": "command", "summary": "On-Device command used in generated start commands.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "file": { "hidden": true, "name": "file", "summary": "MCP config file path override.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "mcp:install", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Install MCP client config.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "mcp", "install.js" ], "aliasPermutations": [], "permutations": [ "mcp:install", "install:mcp" ] }, "mcp:proxy": { "aliases": [], "args": {}, "description": "Proxy remote Spacefast MCP over stdio using the current CLI login.", "flags": { "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "endpoint": { "env": "SPACEFAST_MCP_URL", "name": "endpoint", "summary": "Remote MCP endpoint. HTTPS is required except on loopback.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "allow-credential-origin": { "env": "SPACEFAST_MCP_ALLOW_CREDENTIAL_ORIGIN", "name": "allow-credential-origin", "summary": "Send your Spacefast login to this MCP origin even though it was not issued for it. Repeatable.", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "mcp:proxy", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Run the authenticated remote MCP proxy.", "enableJsonFlag": false, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "mcp", "proxy.js" ], "aliasPermutations": [], "permutations": [ "mcp:proxy", "proxy:mcp" ], "examples": [ { "command": "<%= config.bin %> mcp proxy", "description": "Run the authenticated remote MCP proxy." } ] }, "open": { "aliases": [], "args": { "target": { "description": "Space ID, slug, live URL, Version URL, or domain. Defaults to the linked space.", "name": "target", "required": false } }, "description": "Mint a temporary author handoff and open the private Space. This never creates a recipient Link.", "examples": [ { "command": "<%= config.bin %> open", "description": "Open the linked private Space." }, { "command": "<%= config.bin %> open docs", "description": "Open Space `docs` privately." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "path": { "helpGroup": "Open", "name": "path", "summary": "Clean route to open after the exchange.", "default": "/", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "show-secret": { "helpGroup": "Open", "name": "show-secret", "summary": "Print the temporary handoff URL instead of opening it.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "open", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Open a private Space.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "open.js" ], "aliasPermutations": [], "permutations": [ "open" ] }, "operations": { "aliases": [ "ops" ], "args": { "id": { "description": "Operation ID. Omit to list recent operations.", "name": "id", "required": false } }, "description": "List recent async operations or read one by ID. Pass --space to scope the list to a space.", "examples": [ "<%= config.bin %> ops", "<%= config.bin %> ops op_123", "<%= config.bin %> operations --space spc_123" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "limit": { "name": "limit", "summary": "Maximum number of operations to return (default 50, max 100).", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "cursor": { "name": "cursor", "summary": "Pagination cursor from a previous response.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "operations", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Inspect async operations.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "operations.js" ], "aliasPermutations": [ "ops" ], "permutations": [ "operations" ] }, "pages": { "aliases": [], "args": {}, "description": "Pull, validate, and preview Spacefast-authored pages.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "pages", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Manage Pages templates.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "pages.js" ], "aliasPermutations": [], "permutations": [ "pages" ], "examples": [ { "command": "<%= config.bin %> pages", "description": "Manage Pages templates." } ] }, "pages:pull": { "aliases": [], "args": { "target": { "description": "Page id, layout, or all.", "name": "target", "required": false } }, "description": "Copy Spacefast's readable default page HTML into your project.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "pages:pull", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Own a default page template.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "pages", "pull.js" ], "aliasPermutations": [], "permutations": [ "pages:pull", "pull:pages" ], "examples": [ { "command": "<%= config.bin %> pages pull [target]", "description": "Own a default page template." } ] }, "pages:validate": { "aliases": [], "args": {}, "description": "Run the same structural Pages checks used by publish.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "dir": { "char": "d", "name": "dir", "summary": "Project directory.", "default": ".", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "pages:validate", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Validate local Pages templates.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "pages", "validate.js" ], "aliasPermutations": [], "permutations": [ "pages:validate", "validate:pages" ], "examples": [ { "command": "<%= config.bin %> pages validate", "description": "Validate local Pages templates." } ] }, "plugins": { "aliases": [], "args": {}, "description": "Install the Spacefast plugin lane for agents that support plugins.", "examples": [ { "command": "<%= config.bin %> plugins --agent cursor", "description": "Install the first-party Spacefast plugin for Cursor." }, { "command": "<%= config.bin %> plugins --agent claude-code", "description": "Install the Spacefast plugin for Claude Code." }, { "command": "<%= config.bin %> plugins --agent codex --dry-run", "description": "Print the pinned installer command without running it." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "agent": { "name": "agent", "summary": "Plugin-capable agent to configure.", "default": "claude-code", "hasDynamicHelp": false, "multiple": false, "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" ], "type": "option" }, "dry-run": { "name": "dry-run", "summary": "Print the pinned installer command without changing agent configuration.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "plugins", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Install the Spacefast agent plugin.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "plugins.js" ], "aliasPermutations": [], "permutations": [ "plugins" ] }, "profiles": { "aliases": [], "args": {}, "description": "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": [ { "command": "<%= config.bin %> profiles", "description": "List configured provider profiles." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "profiles", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List provider profiles.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": true, "isESM": true, "relativePath": [ "dist", "commands", "profiles.js" ], "aliasPermutations": [], "permutations": [ "profiles" ] }, "profiles:rm": { "aliases": [ "profiles:remove", "profiles:delete" ], "args": { "name": { "description": "Profile name.", "name": "name", "required": true } }, "description": "Delete a named provider profile and its stored credential.", "examples": [ { "command": "<%= config.bin %> profiles rm staging", "description": "Delete the staging provider profile." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "profiles:rm", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Remove a provider profile.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": true, "isESM": true, "relativePath": [ "dist", "commands", "profiles", "rm.js" ], "aliasPermutations": [ "profiles:remove", "remove:profiles", "profiles:delete", "delete:profiles" ], "permutations": [ "profiles:rm", "rm:profiles" ] }, "profiles:set": { "aliases": [], "args": { "name": { "description": "Profile name.", "name": "name", "required": true } }, "description": "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": [ "<%= config.bin %> profiles set acme --api-url https://api.acme-host.example --token st_...", "<%= config.bin %> profiles set acme --token \"\"" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "helpGroup": "GLOBAL", "name": "api-url", "summary": "Provider API base URL for this profile.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "helpGroup": "Authentication", "name": "token", "summary": "API key bound to this profile. Pass \"\" to clear a saved key.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "profiles:set", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Create or update a provider profile.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": true, "isESM": true, "relativePath": [ "dist", "commands", "profiles", "set.js" ], "aliasPermutations": [], "permutations": [ "profiles:set", "set:profiles" ] }, "profiles:use": { "aliases": [], "args": { "name": { "description": "Profile name.", "name": "name", "required": true } }, "description": "Select the profile used when no --profile flag or env is set.", "examples": [ { "command": "<%= config.bin %> profiles use staging", "description": "Select the staging profile as the default." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "profiles:use", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Select the active provider profile.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": true, "isESM": true, "relativePath": [ "dist", "commands", "profiles", "use.js" ], "aliasPermutations": [], "permutations": [ "profiles:use", "use:profiles" ] }, "promote": { "aliases": [], "args": { "version": { "description": "Version ID, ref, or number to make live, for example ver_123, v12, or 12.", "name": "version", "required": false } }, "description": "Promote an existing ready version to a channel (default live). Use `rollback` to roll back to an older version instead.", "examples": [ { "command": "<%= config.bin %> promote v12", "description": "Make version v12 live." }, { "command": "<%= config.bin %> promote v12 --channel live", "description": "Promote explicitly to the live channel." }, { "command": "<%= config.bin %> promote ver_123 --no-wait --json", "description": "Queue promotion and print the operation as JSON." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "channel": { "helpGroup": "Execution", "name": "channel", "summary": "Channel to point at this version (default \"live\").", "default": "live", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "wait": { "helpGroup": "Execution", "name": "wait", "summary": "Wait until queued work finishes before returning.", "allowNo": true, "type": "boolean" }, "wait-timeout": { "helpGroup": "Execution", "name": "wait-timeout", "summary": "Seconds to wait for the version to become live.", "default": 900, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "promote", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Promote a version to a channel.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "promote.js" ], "aliasPermutations": [], "permutations": [ "promote" ] }, "publish": { "aliases": [ "deploy" ], "args": { "dir": { "description": "File, directory, project, or .zip/.tar.gz archive to publish. Defaults to the current directory.", "name": "dir", "required": false } }, "description": "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.", "examples": [ { "command": "<%= config.bin %> publish ./dist", "description": "Publish a file or directory directly." }, { "command": "<%= config.bin %> publish", "description": "Build a detected project, or publish the directory directly if no build exists." }, { "command": "<%= config.bin %> publish --remote", "description": "Upload source and run the build remotely." }, { "command": "<%= config.bin %> publish ./site.zip", "description": "Publish a file archive, or build a detected project archive remotely." }, { "command": "<%= config.bin %> publish --target preview --json", "description": "Publish an unpromoted preview without moving the live channel." }, { "command": "<%= config.bin %> publish --json --stream", "description": "Stream JSONL build and publish events." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "char": "n", "helpGroup": "Space metadata", "name": "name", "summary": "Set the space title.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "slug": { "helpGroup": "Space metadata", "name": "slug", "summary": "Set the space slug when creating a new space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "hostname-scope": { "helpGroup": "Space metadata", "name": "hostname-scope", "summary": "Managed hostname scope for newly created spaces.", "hasDynamicHelp": false, "multiple": false, "options": [ "team", "global" ], "type": "option" }, "spa": { "helpGroup": "Space metadata", "name": "spa", "summary": "Control single-page app fallback detection.", "default": "auto", "hasDynamicHelp": false, "multiple": false, "options": [ "auto", "true", "false" ], "type": "option" }, "message": { "char": "m", "env": "SPACEFAST_PUBLISH_MESSAGE", "helpGroup": "Version source", "name": "message", "summary": "Changelog entry shown in version history. Overrides the detected git commit message.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "git-branch": { "env": "SPACEFAST_GIT_BRANCH", "helpGroup": "Version source", "name": "git-branch", "summary": "Git branch name to record on the version.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "git-commit": { "env": "SPACEFAST_GIT_COMMIT", "helpGroup": "Version source", "name": "git-commit", "summary": "Git commit SHA to record on the version.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "git-ref": { "env": "SPACEFAST_GIT_REF", "helpGroup": "Version source", "name": "git-ref", "summary": "Git ref to record on the version.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "git-repository": { "env": "SPACEFAST_GIT_REPOSITORY", "helpGroup": "Version source", "name": "git-repository", "summary": "Git repository to record on the version, for example owner/repo.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "source-type": { "env": "SPACEFAST_SOURCE_TYPE", "helpGroup": "Version source", "name": "source-type", "summary": "Version source type to record.", "hasDynamicHelp": false, "multiple": false, "options": [ "direct-upload", "git" ], "type": "option" }, "access": { "helpGroup": "Space metadata", "name": "access", "summary": "Set initial root access when this publish creates a team-owned space.", "hasDynamicHelp": false, "multiple": false, "options": [ "private", "team", "public" ], "type": "option" }, "mode": { "helpGroup": "Space metadata", "name": "mode", "summary": "Serve the space as a website (default) or as a raw file listing. Usually set in sf.jsonc.", "hasDynamicHelp": false, "multiple": false, "options": [ "website", "files" ], "type": "option" }, "target": { "helpGroup": "Execution", "name": "target", "summary": "Publish to production (live) or create a preview version without changing live traffic or existing Space settings.", "hasDynamicHelp": false, "multiple": false, "options": [ "production", "preview" ], "type": "option" }, "dry-run": { "helpGroup": "Execution", "name": "dry-run", "summary": "Print the resolved publish plan without uploading files or writing state.", "allowNo": false, "type": "boolean" }, "config-only": { "helpGroup": "Execution", "name": "config-only", "summary": "Publish a config-only version that carries the prior artifact forward without building or uploading content.", "allowNo": false, "type": "boolean" }, "wait": { "helpGroup": "Execution", "name": "wait", "summary": "Wait until the target version is ready and, for production, live before returning.", "allowNo": true, "type": "boolean" }, "wait-timeout": { "helpGroup": "Execution", "name": "wait-timeout", "summary": "Seconds to wait for the version to become ready.", "default": 900, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "stream": { "helpGroup": "Execution", "name": "stream", "summary": "With --json, emit a JSONL publish event stream instead of a single result.", "allowNo": true, "type": "boolean" }, "show-secret": { "helpGroup": "Output", "name": "show-secret", "summary": "Print the access URL and claim link in JSON or non-interactive output.", "allowNo": false, "type": "boolean" }, "build": { "helpGroup": "Build", "name": "build", "summary": "Force build mode for directories. Archives always use remote project detection.", "allowNo": false, "type": "boolean" }, "remote": { "helpGroup": "Build", "name": "remote", "summary": "Upload source and run the build remotely.", "allowNo": false, "type": "boolean" }, "prebuilt": { "helpGroup": "Build", "name": "prebuilt", "summary": "Publish a prebuilt directory or archive without installing or building.", "allowNo": false, "type": "boolean" }, "root-directory": { "helpGroup": "Build", "name": "root-directory", "summary": "Repository subdirectory that contains the app.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "install-directory": { "helpGroup": "Build", "name": "install-directory", "summary": "Repository subdirectory to run dependency installation from.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "install-command": { "helpGroup": "Build", "name": "install-command", "summary": "Install command. Defaults to package-manager detection.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "build-command": { "helpGroup": "Build", "name": "build-command", "summary": "Build command. Defaults to framework and package script detection.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "output-directory": { "helpGroup": "Build", "name": "output-directory", "summary": "Build output directory relative to the app root.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env-file": { "helpGroup": "Build", "name": "env-file", "summary": "Local dotenv file to load for install/build commands. Repeat for multiple files.", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "ignored-build-command": { "helpGroup": "Build", "name": "ignored-build-command", "summary": "For --remote, command that skips the build when it exits 0.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "source-include": { "helpGroup": "Build", "name": "source-include", "summary": "Ignored file or directory to include in a remote source archive. Repeat for multiple paths.", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "skip-install": { "helpGroup": "Build", "name": "skip-install", "summary": "Skip dependency installation.", "allowNo": false, "type": "boolean" }, "skip-build": { "helpGroup": "Build", "name": "skip-build", "summary": "Skip the build command and publish the selected directory unless --output-directory is set.", "allowNo": false, "type": "boolean" }, "publish-mode": { "helpGroup": "Version", "name": "publish-mode", "summary": "Replace everything in the space (snapshot, default) or add to what is already published (additive).", "hasDynamicHelp": false, "multiple": false, "options": [ "additive", "snapshot" ], "type": "option" }, "immutable-asset-prefix": { "helpGroup": "Version", "name": "immutable-asset-prefix", "summary": "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.", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "allow-unsupported-platform-features": { "helpGroup": "Migration", "name": "allow-unsupported-platform-features", "summary": "Publish even when imported platform config includes features Spacefast cannot convert.", "allowNo": false, "type": "boolean" }, "auto-finalize": { "helpGroup": "Execution", "name": "auto-finalize", "summary": "Finalize a remote build automatically after staging its output.", "allowNo": true, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "publish", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Publish files or built projects to Spacefast.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "rootHelpOrder": 0, "isESM": true, "relativePath": [ "dist", "commands", "publish.js" ], "aliasPermutations": [ "deploy" ], "permutations": [ "publish" ] }, "redeploy": { "aliases": [], "args": { "build": { "description": "Build ID (bld_...) to retry. Defaults to the space's most recent build.", "name": "build", "required": false } }, "description": "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": [ { "command": "<%= config.bin %> redeploy", "description": "Retry the most recent build of the linked space." }, { "command": "<%= config.bin %> redeploy bld_123", "description": "Retry a specific terminal build." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "redeploy", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Retry the latest build (alias of `sf builds retry`).", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "redeploy.js" ], "aliasPermutations": [], "permutations": [ "redeploy" ] }, "rollback": { "aliases": [], "args": { "version": { "description": "Version ID, ref, or number to make live, for example ver_123, v12, or 12.", "name": "version", "required": false } }, "description": "Roll live traffic back to an existing ready version. Use `versions ls` to find a version.", "examples": [ { "command": "<%= config.bin %> versions ls", "description": "List versions and find the target rollback version." }, { "command": "<%= config.bin %> rollback v12", "description": "Make version v12 live." }, { "command": "<%= config.bin %> rollback 12 --space docs", "description": "Make version v12 live for a selected space." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "channel": { "helpGroup": "Execution", "name": "channel", "summary": "Channel to point at this version (default \"live\").", "default": "live", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "wait": { "helpGroup": "Execution", "name": "wait", "summary": "Wait until queued work finishes before returning.", "allowNo": true, "type": "boolean" }, "wait-timeout": { "helpGroup": "Execution", "name": "wait-timeout", "summary": "Seconds to wait for the version to become live.", "default": 900, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "rollback", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Roll back to a previous version.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "rootHelpOrder": 3, "isESM": true, "relativePath": [ "dist", "commands", "rollback.js" ], "aliasPermutations": [], "permutations": [ "rollback" ] }, "routing": { "aliases": [], "args": {}, "description": "Inspect routing configuration and compute redirects/headers.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "routing", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Routing utilities.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "routing.js" ], "aliasPermutations": [], "permutations": [ "routing" ], "examples": [ { "command": "<%= config.bin %> routing", "description": "Routing utilities." } ] }, "routing:compute": { "aliases": [], "args": {}, "description": "Resolve the latest version's _redirects and _headers with current variables.", "examples": [ { "command": "<%= config.bin %> routing compute --space docs", "description": "Resolve the latest version's redirects and headers." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "routing:compute", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Compute routing.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "routing", "compute.js" ], "aliasPermutations": [], "permutations": [ "routing:compute", "compute:routing" ] }, "routing:inspect": { "aliases": [], "args": {}, "description": "Compile local _redirects, _headers, and sf.jsonc routing rules and optionally match URLs against the merged rules.", "examples": [ { "command": "<%= config.bin %> routing inspect", "description": "Compile the routing files in the current directory." }, { "command": "<%= config.bin %> routing inspect --routing ./dist --url /old-path", "description": "Match a path against the compiled local routing rules." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "routing": { "char": "r", "name": "routing", "summary": "Directory containing _redirects, _headers, and sf.jsonc to inspect.", "default": ".", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "url": { "name": "url", "summary": "URL or path to match against local routing rules. Repeat for multiple URLs.", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "routing:inspect", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Inspect local routing files.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "routing", "inspect.js" ], "aliasPermutations": [], "permutations": [ "routing:inspect", "inspect:routing" ] }, "runtime": { "aliases": [], "args": {}, "description": "Inspect what a space is serving and what runs it.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "runtime", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Inspect a space's runtime.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "runtime.js" ], "aliasPermutations": [], "permutations": [ "runtime" ], "examples": [ { "command": "<%= config.bin %> runtime", "description": "Inspect a space's runtime." } ] }, "runtime:status": { "aliases": [], "args": {}, "description": "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": [ { "command": "<%= config.bin %> runtime status", "description": "What the linked space is serving right now." }, { "command": "<%= config.bin %> runtime status --space docs", "description": "The same for space `docs`." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "runtime:status", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Show what a space is serving.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "runtime", "status.js" ], "aliasPermutations": [], "permutations": [ "runtime:status", "status:runtime" ] }, "setup": { "aliases": [], "args": {}, "description": "Generate setup instructions for agents and integrations.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "setup", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Generate setup instructions.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "setup.js" ], "aliasPermutations": [], "permutations": [ "setup" ], "examples": [ { "command": "<%= config.bin %> setup", "description": "Generate setup instructions." } ] }, "setup:agent": { "aliases": [], "args": {}, "description": "Detect agent clients and configure Spacefast skills plus MCP in one idempotent flow.", "examples": [ { "command": "<%= config.bin %> setup agent -y", "description": "Configure detected agents with hosted MCP through the CLI login." }, { "command": "<%= config.bin %> setup agent -y --agent cursor --remote --oauth", "description": "Configure Cursor with direct hosted MCP and editor OAuth." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "name": "yes", "summary": "Skip prompts, auto-detect agents, and accept local stdio MCP.", "allowNo": false, "type": "boolean" }, "agent": { "name": "agent", "summary": "Agent/client to configure. Repeat to configure more than one.", "hasDynamicHelp": false, "multiple": true, "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" ], "type": "option" }, "project": { "char": "p", "name": "project", "summary": "Install skills into this project instead of global agent directories.", "allowNo": false, "type": "boolean" }, "remote": { "name": "remote", "summary": "Use hosted MCP through `sf mcp proxy` and the current CLI login.", "allowNo": false, "type": "boolean" }, "local": { "exclusive": [ "remote", "oauth" ], "name": "local", "summary": "Use checkout-aware local stdio MCP instead of the hosted proxy.", "allowNo": false, "type": "boolean" }, "oauth": { "dependsOn": [ "remote" ], "name": "oauth", "summary": "With --remote, connect directly and let the editor handle OAuth.", "allowNo": false, "type": "boolean" }, "skip-mcp": { "name": "skip-mcp", "summary": "Install skills without configuring MCP.", "allowNo": false, "type": "boolean" }, "endpoint": { "hidden": true, "name": "endpoint", "summary": "Hosted or On-Device MCP endpoint URL override.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "resource": { "hidden": true, "name": "resource", "summary": "OAuth resource identifier for hosted MCP.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "server-name": { "hidden": true, "name": "server-name", "summary": "MCP server name in generated config.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "command": { "hidden": true, "name": "command", "summary": "On-Device command used in generated start commands.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force": { "name": "force", "summary": "Overwrite locally modified or unverified Spacefast skill files.", "allowNo": false, "type": "boolean" }, "handoff": { "name": "handoff", "summary": "Redeem a one-use agent handoff link from the dashboard before generating setup. The link is read from stdin.", "allowNo": false, "type": "boolean" }, "mcp-file": { "hidden": true, "name": "mcp-file", "summary": "MCP config file path override.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "setup:agent", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Install Spacefast agent tooling.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "setup", "agent.js" ], "aliasPermutations": [], "permutations": [ "setup:agent", "agent:setup" ] }, "share": { "aliases": [], "args": {}, "description": "List every active Grant. Use `sf share grant`, `link`, `password`, `token`, or `oidc` to add access.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Manage Space Grants.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share.js" ], "aliasPermutations": [], "permutations": [ "share" ], "examples": [ { "command": "<%= config.bin %> share", "description": "Manage Space Grants." } ] }, "share:check": { "aliases": [], "args": {}, "description": "Explain the exact additive Grants and capabilities matching one route, audience, and target.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "path": { "name": "path", "summary": "Canonical route to check.", "default": "/", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "as": { "name": "as", "summary": "Audience to simulate.", "default": "public", "hasDynamicHelp": false, "multiple": false, "options": [ "public", "team", "person", "link", "password", "machine", "external" ], "type": "option" }, "person": { "name": "person", "summary": "Person id when --as person.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "link": { "name": "link", "summary": "Link id when --as link.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "password": { "name": "password", "summary": "Password credential id when --as password.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "machine": { "name": "machine", "summary": "Machine credential id when --as machine.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "issuer": { "name": "issuer", "summary": "External identity issuer when --as external.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "subject": { "name": "subject", "summary": "External identity subject when --as external.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verified-email": { "name": "verified-email", "summary": "Simulate a principal with a verified email.", "allowNo": false, "type": "boolean" }, "ip": { "name": "ip", "summary": "IP address to evaluate against network constraints.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target": { "name": "target", "summary": "Published target kind.", "default": "live", "hasDynamicHelp": false, "multiple": false, "options": [ "live", "version", "branch" ], "type": "option" }, "target-id": { "name": "target-id", "summary": "Version id or branch name.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:check", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Explain effective Grant access.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "check.js" ], "aliasPermutations": [], "permutations": [ "share:check", "check:share" ], "examples": [ { "command": "<%= config.bin %> share check", "description": "Explain effective Grant access." } ] }, "share:grant": { "aliases": [], "args": {}, "description": "Create one additive Grant. Credential-backed audiences use `sf share link`, `password`, `token`, or `oidc` so their proof and Grant are created together.", "examples": [ { "command": "<%= config.bin %> share grant --to team --role viewer --path '/docs/**'", "description": "Let the owning team view the docs subtree." }, { "command": "<%= config.bin %> share grant --to public --role commenter --path '/proposal/**' --exclude '/proposal/internal/**'", "description": "Publish a review subtree with anonymous Comments." }, { "command": "<%= config.bin %> share grant --to public --role viewer --path '/**' --target all-versions", "description": "Make every immutable Version public." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "wait": { "helpGroup": "Execution", "name": "wait", "summary": "Wait until queued work finishes before returning.", "allowNo": true, "type": "boolean" }, "to": { "helpGroup": "Grant", "name": "to", "required": true, "summary": "Audience: public or team.", "hasDynamicHelp": false, "multiple": false, "options": [ "public", "team" ], "type": "option" }, "role": { "helpGroup": "Grant", "name": "role", "required": true, "summary": "Role: viewer, commenter, editor, or manager.", "hasDynamicHelp": false, "multiple": false, "options": [ "viewer", "commenter", "editor", "manager" ], "type": "option" }, "path": { "helpGroup": "Grant", "name": "path", "required": true, "summary": "Included route pattern. Repeat for disjoint paths.", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "exclude": { "helpGroup": "Grant", "name": "exclude", "summary": "Excluded route pattern local to this Grant. Repeatable.", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "target": { "helpGroup": "Grant", "name": "target", "summary": "live, all-versions, version:, or branch:.", "default": "live", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "helpGroup": "Grant", "name": "name", "summary": "Human-readable Grant name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "expires": { "helpGroup": "Grant", "name": "expires", "summary": "Expire after a duration such as 7d or 30m.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "network": { "helpGroup": "Constraints", "name": "network", "summary": "Allowed IP address or CIDR. Repeatable.", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "country": { "helpGroup": "Constraints", "name": "country", "summary": "Allowed ISO country code. Repeatable.", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "exclude-country": { "helpGroup": "Constraints", "name": "exclude-country", "summary": "Blocked ISO country code. Repeatable.", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "exclude-user-agent": { "helpGroup": "Constraints", "name": "exclude-user-agent", "summary": "Block user agents containing this text. Repeatable.", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:grant", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Create a Space Grant.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "grant.js" ], "aliasPermutations": [], "permutations": [ "share:grant", "grant:share" ] }, "share:grant:edit": { "aliases": [], "args": { "id": { "description": "Managed Grant id.", "name": "id", "required": true } }, "description": "Replace editable dimensions of a direct managed Grant while preserving its stable id.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "wait": { "helpGroup": "Execution", "name": "wait", "summary": "Wait until queued work finishes before returning.", "allowNo": true, "type": "boolean" }, "name": { "name": "name", "summary": "New human-readable Grant name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "role": { "name": "role", "summary": "Replace the role: viewer, commenter, editor, or manager.", "hasDynamicHelp": false, "multiple": false, "options": [ "viewer", "commenter", "editor", "manager" ], "type": "option" }, "path": { "name": "path", "summary": "Replace included route patterns. Repeat for disjoint paths.", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "exclude": { "dependsOn": [ "path" ], "name": "exclude", "summary": "Excluded route pattern for the replacement path set. Repeatable.", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "target": { "name": "target", "summary": "Replace the target: live, all-versions, version:, or branch:.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "expires": { "exclusive": [ "no-expiry" ], "name": "expires", "summary": "New lifetime from now (e.g. 30m, 24h, 7d).", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-expiry": { "exclusive": [ "expires" ], "name": "no-expiry", "summary": "Remove the Grant expiry.", "allowNo": false, "type": "boolean" }, "network": { "exclusive": [ "no-network" ], "helpGroup": "Constraints", "name": "network", "summary": "Replace allowed IP addresses or CIDRs. Repeatable.", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "country": { "exclusive": [ "no-network" ], "helpGroup": "Constraints", "name": "country", "summary": "Replace allowed ISO country codes. Repeatable.", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "exclude-country": { "exclusive": [ "no-network" ], "helpGroup": "Constraints", "name": "exclude-country", "summary": "Replace blocked ISO country codes. Repeatable.", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "exclude-user-agent": { "exclusive": [ "no-network" ], "helpGroup": "Constraints", "name": "exclude-user-agent", "summary": "Replace blocked user-agent substrings. Repeatable.", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "no-network": { "exclusive": [ "network", "country", "exclude-country", "exclude-user-agent" ], "helpGroup": "Constraints", "name": "no-network", "summary": "Remove every network constraint from this Grant.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:grant:edit", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Edit a direct managed Grant.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "grant", "edit.js" ], "aliasPermutations": [], "permutations": [ "share:grant:edit", "grant:share:edit", "grant:edit:share", "share:edit:grant", "edit:share:grant", "edit:grant:share" ], "examples": [ { "command": "<%= config.bin %> share grant edit ", "description": "Edit a direct managed Grant." } ] }, "share:identity": { "aliases": [], "args": {}, "description": "Connect OIDC or a white-label signer, then grant external subjects precise capabilities and paths.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:identity", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Manage external identity access.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "identity.js" ], "aliasPermutations": [], "permutations": [ "share:identity", "identity:share" ], "examples": [ { "command": "<%= config.bin %> share identity", "description": "Manage external identity access." } ] }, "share:identity:create": { "aliases": [], "args": {}, "description": "Create an OIDC connection or a white-label Ed25519 signer connection for a Team.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "type": { "name": "type", "required": true, "hasDynamicHelp": false, "multiple": false, "options": [ "oidc", "signer" ], "type": "option" }, "name": { "name": "name", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "issuer": { "name": "issuer", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "client-id": { "name": "client-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "client-secret": { "name": "client-secret", "noCacheDefault": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "authorize-url": { "name": "authorize-url", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "key": { "name": "key", "summary": "Signer key in \"kid:base64url-public-key\" form. Repeat during rotation.", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:identity:create", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Create an identity connection.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "identity", "create.js" ], "aliasPermutations": [], "permutations": [ "share:identity:create", "identity:share:create", "identity:create:share", "share:create:identity", "create:share:identity", "create:identity:share" ], "examples": [ { "command": "<%= config.bin %> share identity create --type --name --issuer ", "description": "Create an identity connection." } ] }, "share:identity:grant": { "aliases": [], "args": {}, "description": "Grant one externally proven subject precise capabilities and paths on a Space.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "connection": { "name": "connection", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "subject": { "name": "subject", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "name": "name", "required": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "role": { "name": "role", "default": "viewer", "hasDynamicHelp": false, "multiple": false, "options": [ "viewer", "commenter", "editor", "manager" ], "type": "option" }, "path": { "name": "path", "default": [ "/**" ], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "except": { "name": "except", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "target": { "name": "target", "summary": "live, all-versions, version:, or branch:.", "default": "live", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "not-before": { "helpGroup": "Constraints", "name": "not-before", "summary": "Do not admit this Grant before this ISO date-time.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "expires": { "helpGroup": "Constraints", "name": "expires", "summary": "Expire after a duration such as 7d or 30m.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "max-uses": { "helpGroup": "Constraints", "name": "max-uses", "summary": "Maximum successful admissions before the Grant stops working.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "network": { "helpGroup": "Constraints", "name": "network", "summary": "Allowed IP address or CIDR. Repeatable.", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "country": { "helpGroup": "Constraints", "name": "country", "summary": "Allowed ISO country code. Repeatable.", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "exclude-country": { "helpGroup": "Constraints", "name": "exclude-country", "summary": "Blocked ISO country code. Repeatable.", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "exclude-user-agent": { "helpGroup": "Constraints", "name": "exclude-user-agent", "summary": "Block user agents containing this text. Repeatable.", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "require-verified-email": { "helpGroup": "Constraints", "name": "require-verified-email", "summary": "Require email verification for this credential.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:identity:grant", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Create an external identity Grant.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "identity", "grant.js" ], "aliasPermutations": [], "permutations": [ "share:identity:grant", "identity:share:grant", "identity:grant:share", "share:grant:identity", "grant:share:identity", "grant:identity:share" ], "examples": [ { "command": "<%= config.bin %> share identity grant --connection --subject --name ", "description": "Create an external identity Grant." } ] }, "share:identity:ls": { "aliases": [ "share:identity:list" ], "args": {}, "description": "List Team OIDC and white-label signer connections.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:identity:ls", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List identity connections.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "identity", "ls.js" ], "aliasPermutations": [ "share:identity:list", "identity:share:list", "identity:list:share", "share:list:identity", "list:share:identity", "list:identity:share" ], "permutations": [ "share:identity:ls", "identity:share:ls", "identity:ls:share", "share:ls:identity", "ls:share:identity", "ls:identity:share" ], "examples": [ { "command": "<%= config.bin %> share identity ls", "description": "List identity connections." } ] }, "share:identity:revoke": { "aliases": [], "args": { "connection": { "description": "Identity connection id.", "name": "connection", "required": true } }, "description": "Revoke an identity connection, its external Grants, and admitted sessions.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:identity:revoke", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Revoke an identity connection.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "identity", "revoke.js" ], "aliasPermutations": [], "permutations": [ "share:identity:revoke", "identity:share:revoke", "identity:revoke:share", "share:revoke:identity", "revoke:share:identity", "revoke:identity:share" ], "examples": [ { "command": "<%= config.bin %> share identity revoke ", "description": "Revoke an identity connection." } ] }, "share:identity:update": { "aliases": [], "args": { "connection": { "description": "Identity connection id.", "name": "connection", "required": true } }, "description": "Rotate OIDC secrets or signer keys and update connection settings without changing external Grants.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "name": "name", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "client-id": { "name": "client-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "client-secret": { "name": "client-secret", "noCacheDefault": true, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "authorize-url": { "name": "authorize-url", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "key": { "name": "key", "summary": "Complete replacement signer key set in \"kid:base64url-public-key\" form. Repeat to overlap old and new keys.", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "session-ttl": { "name": "session-ttl", "summary": "Admitted session lifetime, for example 30m or 8h.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:identity:update", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Update or rotate an identity connection.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "identity", "update.js" ], "aliasPermutations": [], "permutations": [ "share:identity:update", "identity:share:update", "identity:update:share", "share:update:identity", "update:share:identity", "update:identity:share" ], "examples": [ { "command": "<%= config.bin %> share identity update ", "description": "Update or rotate an identity connection." } ] }, "share:link": { "aliases": [], "args": {}, "description": "Create, list, edit, copy, and revoke named Links. Each Link owns one Grant with paths, exclusions, capabilities, and a serving target.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:link", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Manage Links.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "link.js" ], "aliasPermutations": [], "permutations": [ "share:link", "link:share" ], "examples": [ { "command": "<%= config.bin %> share link", "description": "Manage Links." } ] }, "share:link:copy": { "aliases": [], "args": { "id": { "description": "Share link id (see `sf share link ls`).", "name": "id", "required": true } }, "description": "Print a Link's durable share URL.", "examples": [ { "command": "<%= config.bin %> share link copy lnk_123", "description": "Print the Link's share URL." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "show-secret": { "helpGroup": "Link", "name": "show-secret", "summary": "Print the share URL even when output is JSON or non-interactive.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:link:copy", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Copy a Link.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "link", "copy.js" ], "aliasPermutations": [], "permutations": [ "share:link:copy", "link:share:copy", "link:copy:share", "share:copy:link", "copy:share:link", "copy:link:share" ] }, "share:link:create": { "aliases": [], "args": {}, "description": "Create a named Link backed by one Grant. Links can View or Comment on multiple path patterns.", "examples": [ { "command": "<%= config.bin %> share link create --landing /docs --path \"/docs/**\" --path \"/assets/**\" --exclude \"/docs/internal/**\" --role commenter --name \"Client review\" --expires 7d", "description": "Create a client Link that can comment on two path groups except internal docs." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "landing": { "helpGroup": "Link", "name": "landing", "summary": "Clean route opened after exchange.", "default": "/", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "path": { "helpGroup": "Link", "name": "path", "summary": "Included route pattern. Repeat for disjoint paths.", "default": [ "/**" ], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "exclude": { "helpGroup": "Link", "name": "exclude", "summary": "Excluded route pattern local to this Link. Repeatable.", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "role": { "helpGroup": "Link", "name": "role", "summary": "Role: viewer or commenter. Defaults to commenter.", "default": "commenter", "hasDynamicHelp": false, "multiple": false, "options": [ "viewer", "commenter" ], "type": "option" }, "target": { "helpGroup": "Link", "name": "target", "summary": "live, all-versions, version:, or branch:.", "default": "live", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "not-before": { "helpGroup": "Constraints", "name": "not-before", "summary": "Do not admit this Link before this ISO date-time.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "expires": { "helpGroup": "Constraints", "name": "expires", "summary": "How long the link lasts (e.g. 30m, 24h, 7d). Omit for no expiry.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "max-uses": { "helpGroup": "Constraints", "name": "max-uses", "summary": "Maximum successful opens before the Link stops working.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "require-verified-email": { "helpGroup": "Constraints", "name": "require-verified-email", "summary": "Admit only visitors whose session has a verified email.", "allowNo": false, "type": "boolean" }, "network": { "helpGroup": "Constraints", "name": "network", "summary": "Allowed IP address or CIDR. Repeatable.", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "country": { "helpGroup": "Constraints", "name": "country", "summary": "Allowed ISO country code. Repeatable.", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "exclude-country": { "helpGroup": "Constraints", "name": "exclude-country", "summary": "Blocked ISO country code. Repeatable.", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "exclude-user-agent": { "helpGroup": "Constraints", "name": "exclude-user-agent", "summary": "Block user agents containing this text. Repeatable.", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "name": { "helpGroup": "Link", "name": "name", "required": true, "summary": "Human name shown in the Links list.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "show-secret": { "helpGroup": "Link", "name": "show-secret", "summary": "Print the share URL even when output is JSON or non-interactive.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:link:create", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Create a Link.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "link", "create.js" ], "aliasPermutations": [], "permutations": [ "share:link:create", "link:share:create", "link:create:share", "share:create:link", "create:share:link", "create:link:share" ] }, "share:link:edit": { "aliases": [], "args": { "id": { "description": "Link id.", "name": "id", "required": true } }, "description": "Replace a Link's metadata or Grant dimensions without rotating its stable URL.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "helpGroup": "Link", "name": "name", "summary": "New Link name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "landing": { "helpGroup": "Link", "name": "landing", "summary": "New clean landing path.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "path": { "helpGroup": "Link", "name": "path", "summary": "Replace included route patterns. Repeat for disjoint paths.", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "exclude": { "dependsOn": [ "path" ], "helpGroup": "Link", "name": "exclude", "summary": "Excluded route pattern for the replacement path set. Repeatable.", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "role": { "helpGroup": "Link", "name": "role", "summary": "Replace the role: viewer or commenter.", "hasDynamicHelp": false, "multiple": false, "options": [ "viewer", "commenter" ], "type": "option" }, "target": { "helpGroup": "Link", "name": "target", "summary": "Replace the target: live, all-versions, version:, or branch:.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "not-before": { "exclusive": [ "no-not-before" ], "helpGroup": "Constraints", "name": "not-before", "summary": "Replace the earliest admission time with this ISO date-time.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-not-before": { "exclusive": [ "not-before" ], "helpGroup": "Constraints", "name": "no-not-before", "summary": "Remove the earliest admission time.", "allowNo": false, "type": "boolean" }, "expires": { "exclusive": [ "no-expiry" ], "helpGroup": "Constraints", "name": "expires", "summary": "New lifetime from now (e.g. 30m, 24h, 7d).", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-expiry": { "exclusive": [ "expires" ], "helpGroup": "Constraints", "name": "no-expiry", "summary": "Remove the Link expiry.", "allowNo": false, "type": "boolean" }, "max-uses": { "exclusive": [ "no-max-uses" ], "helpGroup": "Constraints", "name": "max-uses", "summary": "Replace the maximum successful opens.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-max-uses": { "exclusive": [ "max-uses" ], "helpGroup": "Constraints", "name": "no-max-uses", "summary": "Remove the open limit.", "allowNo": false, "type": "boolean" }, "require-verified-email": { "exclusive": [ "allow-unverified-email" ], "helpGroup": "Constraints", "name": "require-verified-email", "summary": "Require a verified email.", "allowNo": false, "type": "boolean" }, "allow-unverified-email": { "exclusive": [ "require-verified-email" ], "helpGroup": "Constraints", "name": "allow-unverified-email", "summary": "Remove the verified-email requirement.", "allowNo": false, "type": "boolean" }, "network": { "exclusive": [ "no-network" ], "helpGroup": "Constraints", "name": "network", "summary": "Replace allowed IP addresses or CIDRs. Repeatable.", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "country": { "exclusive": [ "no-network" ], "helpGroup": "Constraints", "name": "country", "summary": "Replace allowed ISO country codes. Repeatable.", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "exclude-country": { "exclusive": [ "no-network" ], "helpGroup": "Constraints", "name": "exclude-country", "summary": "Replace blocked ISO country codes. Repeatable.", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "exclude-user-agent": { "exclusive": [ "no-network" ], "helpGroup": "Constraints", "name": "exclude-user-agent", "summary": "Replace blocked user-agent substrings. Repeatable.", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "no-network": { "exclusive": [ "network" ], "helpGroup": "Constraints", "name": "no-network", "summary": "Remove network restrictions.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:link:edit", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Edit Link metadata.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "link", "edit.js" ], "aliasPermutations": [], "permutations": [ "share:link:edit", "link:share:edit", "link:edit:share", "share:edit:link", "edit:share:link", "edit:link:share" ], "examples": [ { "command": "<%= config.bin %> share link edit ", "description": "Edit Link metadata." } ] }, "share:link:ls": { "aliases": [ "share:link:list" ], "args": {}, "description": "List named Links with Grant paths, capabilities, target, expiry, and lifecycle. List reads never carry credentials.", "examples": [ { "command": "<%= config.bin %> share link ls --space docs", "description": "List share links for the docs space." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:link:ls", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List Links.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "link", "ls.js" ], "aliasPermutations": [ "share:link:list", "link:share:list", "link:list:share", "share:list:link", "list:share:link", "list:link:share" ], "permutations": [ "share:link:ls", "link:share:ls", "link:ls:share", "share:ls:link", "ls:share:link", "ls:link:share" ] }, "share:link:revoke": { "aliases": [], "args": { "id": { "description": "Share link id (see `sf share link ls`).", "name": "id", "required": true } }, "description": "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": [ { "command": "<%= config.bin %> share link revoke lnk_123", "description": "Revoke a share link." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:link:revoke", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Revoke a Link.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "link", "revoke.js" ], "aliasPermutations": [], "permutations": [ "share:link:revoke", "link:share:revoke", "link:revoke:share", "share:revoke:link", "revoke:share:link", "revoke:link:share" ] }, "share:list": { "aliases": [ "share:ls" ], "args": {}, "description": "List every active Grant, including config, team, Person, Link, password, machine, and external identity access.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:list", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List Space Grants.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "list.js" ], "aliasPermutations": [ "share:ls", "ls:share" ], "permutations": [ "share:list", "list:share" ], "examples": [ { "command": "<%= config.bin %> share list", "description": "List Space Grants." } ] }, "share:password": { "aliases": [], "args": {}, "description": "Create, list, rotate, and revoke named password Grants. Passwords never live in sf.jsonc.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:password", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Manage password access.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "password.js" ], "aliasPermutations": [], "permutations": [ "share:password", "password:share" ], "examples": [ { "command": "<%= config.bin %> share password", "description": "Manage password access." } ] }, "share:password:create": { "aliases": [], "args": {}, "description": "Create a named scoped password Grant. The verifier is Argon2id and rotation fences existing sessions.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "name": "name", "required": true, "summary": "Human-readable password name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "password": { "env": "SPACEFAST_SHARE_PASSWORD", "name": "password", "summary": "Password, or set SPACEFAST_SHARE_PASSWORD.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "password-from-stdin": { "name": "password-from-stdin", "summary": "Read the password from standard input.", "allowNo": false, "type": "boolean" }, "role": { "name": "role", "summary": "Role granted to password holders.", "default": "commenter", "hasDynamicHelp": false, "multiple": false, "options": [ "viewer", "commenter" ], "type": "option" }, "path": { "name": "path", "required": true, "summary": "Included route pattern.", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "exclude": { "name": "exclude", "summary": "Local exclusion pattern.", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "target": { "name": "target", "summary": "Published target selector.", "default": "live", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "not-before": { "helpGroup": "Constraints", "name": "not-before", "summary": "Do not admit this Grant before this ISO date-time.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "expires": { "helpGroup": "Constraints", "name": "expires", "summary": "Expire after a duration such as 7d or 30m.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "max-uses": { "helpGroup": "Constraints", "name": "max-uses", "summary": "Maximum successful admissions before the Grant stops working.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "network": { "helpGroup": "Constraints", "name": "network", "summary": "Allowed IP address or CIDR. Repeatable.", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "country": { "helpGroup": "Constraints", "name": "country", "summary": "Allowed ISO country code. Repeatable.", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "exclude-country": { "helpGroup": "Constraints", "name": "exclude-country", "summary": "Blocked ISO country code. Repeatable.", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "exclude-user-agent": { "helpGroup": "Constraints", "name": "exclude-user-agent", "summary": "Block user agents containing this text. Repeatable.", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "require-verified-email": { "helpGroup": "Constraints", "name": "require-verified-email", "summary": "Require email verification for this credential.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:password:create", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Create password access.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "password", "create.js" ], "aliasPermutations": [], "permutations": [ "share:password:create", "password:share:create", "password:create:share", "share:create:password", "create:share:password", "create:password:share" ], "examples": [ { "command": "<%= config.bin %> share password create --name --path ", "description": "Create password access." } ] }, "share:password:ls": { "aliases": [ "share:password:list" ], "args": {}, "description": "List password proof metadata and the Grants they admit.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:password:ls", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List password access.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "password", "ls.js" ], "aliasPermutations": [ "share:password:list", "password:share:list", "password:list:share", "share:list:password", "list:share:password", "list:password:share" ], "permutations": [ "share:password:ls", "password:share:ls", "password:ls:share", "share:ls:password", "ls:share:password", "ls:password:share" ], "examples": [ { "command": "<%= config.bin %> share password ls", "description": "List password access." } ] }, "share:password:revoke": { "aliases": [], "args": { "id": { "description": "Password credential id.", "name": "id", "required": true } }, "description": "Revoke password access and its canonical Grant.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:password:revoke", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Revoke password access.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "password", "revoke.js" ], "aliasPermutations": [], "permutations": [ "share:password:revoke", "password:share:revoke", "password:revoke:share", "share:revoke:password", "revoke:share:password", "revoke:password:share" ], "examples": [ { "command": "<%= config.bin %> share password revoke ", "description": "Revoke password access." } ] }, "share:password:rotate": { "aliases": [], "args": { "id": { "description": "Password credential id.", "name": "id", "required": true } }, "description": "Replace a password and immediately fence sessions using the old one.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "password": { "env": "SPACEFAST_SHARE_PASSWORD", "name": "password", "summary": "New password, or set SPACEFAST_SHARE_PASSWORD.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "password-from-stdin": { "name": "password-from-stdin", "summary": "Read the new password from standard input.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:password:rotate", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Rotate a password.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "password", "rotate.js" ], "aliasPermutations": [], "permutations": [ "share:password:rotate", "password:share:rotate", "password:rotate:share", "share:rotate:password", "rotate:share:password", "rotate:password:share" ], "examples": [ { "command": "<%= config.bin %> share password rotate ", "description": "Rotate a password." } ] }, "share:people": { "aliases": [], "args": {}, "description": "Invite, list, resend, edit, and remove People. A Person can hold roles on multiple route subtrees.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:people", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Manage People.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "people.js" ], "aliasPermutations": [], "permutations": [ "share:people", "people:share" ], "examples": [ { "command": "<%= config.bin %> share people", "description": "Manage People." } ] }, "share:people:edit": { "aliases": [], "args": { "person": { "description": "Person id or email address.", "name": "person", "required": true } }, "description": "Replace a Person's scoped roles atomically. Repeat --grant for every route subtree they should retain.", "examples": [ { "command": "<%= config.bin %> share people edit person@example.com --grant /=viewer --grant /docs=editor", "description": "Keep root viewing and grant editing under /docs." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "grant": { "helpGroup": "People", "name": "grant", "required": true, "summary": "Scoped role in = form. Repeat to replace the full grant set.", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "target": { "helpGroup": "People", "name": "target", "summary": "live, all-versions, version:, or branch:.", "default": "live", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:people:edit", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Edit a Person's scoped roles.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "people", "edit.js" ], "aliasPermutations": [], "permutations": [ "share:people:edit", "people:share:edit", "people:edit:share", "share:edit:people", "edit:share:people", "edit:people:share" ] }, "share:people:invite": { "aliases": [], "args": { "email": { "description": "Email address to invite.", "name": "email", "required": true } }, "description": "Invite one Person without requiring an account. Repeat --scope to grant the same role on multiple route subtrees.", "examples": [ { "command": "<%= config.bin %> share people invite person@example.com --role commenter --scope /docs --scope /assets", "description": "Invite a commenter to two route subtrees." }, { "command": "<%= config.bin %> share people invite client@example.com --role viewer --target version:ver_123", "description": "Invite someone to one immutable version instead of the live space." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "role": { "helpGroup": "People", "name": "role", "summary": "Role granted on every supplied scope.", "default": "viewer", "hasDynamicHelp": false, "multiple": false, "options": [ "viewer", "commenter", "editor", "manager" ], "type": "option" }, "scope": { "helpGroup": "People", "name": "scope", "summary": "Canonical route subtree. Repeat for multiple scopes.", "default": [ "/" ], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "target": { "helpGroup": "People", "name": "target", "summary": "live, all-versions, version:, or branch:.", "default": "live", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:people:invite", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Invite a Person.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "people", "invite.js" ], "aliasPermutations": [], "permutations": [ "share:people:invite", "people:share:invite", "people:invite:share", "share:invite:people", "invite:share:people", "invite:people:share" ] }, "share:people:ls": { "aliases": [ "share:people:list" ], "args": {}, "description": "List People and every scoped role they hold.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:people:ls", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List People.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "people", "ls.js" ], "aliasPermutations": [ "share:people:list", "people:share:list", "people:list:share", "share:list:people", "list:share:people", "list:people:share" ], "permutations": [ "share:people:ls", "people:share:ls", "people:ls:share", "share:ls:people", "ls:share:people", "ls:people:share" ], "examples": [ { "command": "<%= config.bin %> share people ls", "description": "List People." } ] }, "share:people:remove": { "aliases": [], "args": { "person": { "description": "Person id or email (see `sf share people ls`).", "name": "person", "required": true } }, "description": "Remove a Person and all of their scoped grants.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:people:remove", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Remove a Person.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "people", "remove.js" ], "aliasPermutations": [], "permutations": [ "share:people:remove", "people:share:remove", "people:remove:share", "share:remove:people", "remove:share:people", "remove:people:share" ], "examples": [ { "command": "<%= config.bin %> share people remove ", "description": "Remove a Person." } ] }, "share:people:resend": { "aliases": [], "args": { "person": { "description": "Person id or email.", "name": "person", "required": true } }, "description": "Replace a pending Person invitation and send a fresh accountless acceptance email.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:people:resend", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Resend a Person invitation.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "people", "resend.js" ], "aliasPermutations": [], "permutations": [ "share:people:resend", "people:share:resend", "people:resend:share", "share:resend:people", "resend:share:people", "resend:people:share" ], "examples": [ { "command": "<%= config.bin %> share people resend ", "description": "Resend a Person invitation." } ] }, "share:request": { "aliases": [], "args": {}, "description": "List, approve, and deny inbox-verified access requests.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:request", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Manage access requests.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "request.js" ], "aliasPermutations": [], "permutations": [ "share:request", "request:share" ], "examples": [ { "command": "<%= config.bin %> share request", "description": "Manage access requests." } ] }, "share:request:approve": { "aliases": [], "args": { "id": { "description": "Access request id.", "name": "id", "required": true } }, "description": "Approve an access request into the canonical People list. Override the requested role or route scopes when needed.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "role": { "helpGroup": "Approve", "name": "role", "summary": "Approved role. Defaults to the requested role.", "hasDynamicHelp": false, "multiple": false, "options": [ "viewer", "commenter", "editor", "manager" ], "type": "option" }, "scope": { "helpGroup": "Approve", "name": "scope", "summary": "Approved route subtree. Defaults to the requested scope.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:request:approve", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Approve an access request.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "request", "approve.js" ], "aliasPermutations": [], "permutations": [ "share:request:approve", "request:share:approve", "request:approve:share", "share:approve:request", "approve:share:request", "approve:request:share" ], "examples": [ { "command": "<%= config.bin %> share request approve ", "description": "Approve an access request." } ] }, "share:request:deny": { "aliases": [], "args": { "id": { "description": "Access request id.", "name": "id", "required": true } }, "description": "Deny a pending access request.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:request:deny", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Deny an access request.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "request", "deny.js" ], "aliasPermutations": [], "permutations": [ "share:request:deny", "request:share:deny", "request:deny:share", "share:deny:request", "deny:share:request", "deny:request:share" ], "examples": [ { "command": "<%= config.bin %> share request deny ", "description": "Deny an access request." } ] }, "share:request:ls": { "aliases": [ "share:request:list" ], "args": {}, "description": "List pending access requests with requested role and route scope.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:request:ls", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List access requests.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "request", "ls.js" ], "aliasPermutations": [ "share:request:list", "request:share:list", "request:list:share", "share:list:request", "list:share:request", "list:request:share" ], "permutations": [ "share:request:ls", "request:share:ls", "request:ls:share", "share:ls:request", "ls:share:request", "ls:request:share" ], "examples": [ { "command": "<%= config.bin %> share request ls", "description": "List access requests." } ] }, "share:revoke": { "aliases": [], "args": { "id": { "description": "Grant id (see `sf share list`).", "name": "id", "required": true } }, "description": "Revoke one managed Grant. Change config Grants in sf.jsonc. Credential Grants normally revoke through their credential command.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "wait": { "helpGroup": "Execution", "name": "wait", "summary": "Wait until queued work finishes before returning.", "allowNo": true, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:revoke", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Revoke a Space Grant.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "revoke.js" ], "aliasPermutations": [], "permutations": [ "share:revoke", "revoke:share" ], "examples": [ { "command": "<%= config.bin %> share revoke ", "description": "Revoke a Space Grant." } ] }, "share:token": { "aliases": [], "args": {}, "description": "Manage header-only machine credentials backed by scoped Grants.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:token", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Manage machine access.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "token.js" ], "aliasPermutations": [], "permutations": [ "share:token", "token:share" ], "examples": [ { "command": "<%= config.bin %> share token", "description": "Manage machine access." } ] }, "share:token:create": { "aliases": [], "args": {}, "description": "Create a named header-only machine credential and scoped Grant. The token is returned once.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "name": "name", "required": true, "summary": "Human-readable machine name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "role": { "name": "role", "summary": "Role granted to this machine.", "default": "viewer", "hasDynamicHelp": false, "multiple": false, "options": [ "viewer", "commenter", "editor", "manager" ], "type": "option" }, "path": { "name": "path", "required": true, "summary": "Included route pattern.", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "exclude": { "name": "exclude", "summary": "Local exclusion pattern.", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "target": { "name": "target", "summary": "Published target selector.", "default": "live", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "not-before": { "helpGroup": "Constraints", "name": "not-before", "summary": "Do not admit this Grant before this ISO date-time.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "expires": { "helpGroup": "Constraints", "name": "expires", "summary": "Expire after a duration such as 7d or 30m.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "max-uses": { "helpGroup": "Constraints", "name": "max-uses", "summary": "Maximum successful admissions before the Grant stops working.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "network": { "helpGroup": "Constraints", "name": "network", "summary": "Allowed IP address or CIDR. Repeatable.", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "country": { "helpGroup": "Constraints", "name": "country", "summary": "Allowed ISO country code. Repeatable.", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "exclude-country": { "helpGroup": "Constraints", "name": "exclude-country", "summary": "Blocked ISO country code. Repeatable.", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "exclude-user-agent": { "helpGroup": "Constraints", "name": "exclude-user-agent", "summary": "Block user agents containing this text. Repeatable.", "default": [], "hasDynamicHelp": false, "multiple": true, "type": "option" }, "show-secret": { "name": "show-secret", "summary": "Print the one-time token in JSON or non-interactive output.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:token:create", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Create a machine credential.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "token", "create.js" ], "aliasPermutations": [], "permutations": [ "share:token:create", "token:share:create", "token:create:share", "share:create:token", "create:share:token", "create:token:share" ], "examples": [ { "command": "<%= config.bin %> share token create --name --path ", "description": "Create a machine credential." } ] }, "share:token:ls": { "aliases": [ "share:token:list" ], "args": {}, "description": "List machine credential metadata and the Grants they admit.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:token:ls", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List machine access.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "token", "ls.js" ], "aliasPermutations": [ "share:token:list", "token:share:list", "token:list:share", "share:list:token", "list:share:token", "list:token:share" ], "permutations": [ "share:token:ls", "token:share:ls", "token:ls:share", "share:ls:token", "ls:share:token", "ls:token:share" ], "examples": [ { "command": "<%= config.bin %> share token ls", "description": "List machine access." } ] }, "share:token:revoke": { "aliases": [], "args": { "id": { "description": "Machine credential id.", "name": "id", "required": true } }, "description": "Revoke a machine credential and its canonical Grant.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:token:revoke", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Revoke machine access.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "token", "revoke.js" ], "aliasPermutations": [], "permutations": [ "share:token:revoke", "token:share:revoke", "token:revoke:share", "share:revoke:token", "revoke:share:token", "revoke:token:share" ], "examples": [ { "command": "<%= config.bin %> share token revoke ", "description": "Revoke machine access." } ] }, "share:token:rotate": { "aliases": [], "args": { "id": { "description": "Machine credential id.", "name": "id", "required": true } }, "description": "Rotate a machine credential, fence the old token, and return the replacement once.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "show-secret": { "name": "show-secret", "summary": "Print the one-time token in JSON or non-interactive output.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "share:token:rotate", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Rotate a machine credential.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "share", "token", "rotate.js" ], "aliasPermutations": [], "permutations": [ "share:token:rotate", "token:share:rotate", "token:rotate:share", "share:rotate:token", "rotate:share:token", "rotate:token:share" ], "examples": [ { "command": "<%= config.bin %> share token rotate ", "description": "Rotate a machine credential." } ] }, "skills": { "aliases": [ "skills:install" ], "args": {}, "description": "Install or update the Spacefast agent skill bundled with this CLI.", "examples": [ { "command": "<%= config.bin %> skills", "description": "Install or update the Spacefast skill for detected agents." }, { "command": "<%= config.bin %> skills --agent codex", "description": "Install or update the Spacefast skill for Codex." }, { "command": "<%= config.bin %> skills --agent all", "description": "Install the Spacefast skill to every supported agent." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "agent": { "name": "agent", "summary": "Agent to install for. `auto` configures detected agents plus .agents/skills.", "hasDynamicHelp": false, "multiple": true, "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" ], "type": "option" }, "project": { "char": "p", "name": "project", "summary": "Install into this project instead of the agent's global skills directory.", "allowNo": false, "type": "boolean" }, "list": { "char": "l", "name": "list", "summary": "List bundled skill files without installing.", "allowNo": false, "type": "boolean" }, "force": { "name": "force", "summary": "Overwrite locally modified or unverified Spacefast skill files.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "skills", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Install or update Spacefast agent skills.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "skills.js" ], "aliasPermutations": [ "skills:install", "install:skills" ], "permutations": [ "skills" ] }, "skills:remove": { "aliases": [ "skills:rm", "skills:uninstall" ], "args": {}, "description": "Remove the Spacefast skill while preserving locally modified files unless forced.", "examples": [ { "command": "<%= config.bin %> skills remove --agent codex", "description": "Remove the global Codex installation." }, { "command": "<%= config.bin %> skills remove --project --agent claude-code", "description": "Remove this project's Claude Code installation." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "agent": { "name": "agent", "summary": "Agent to remove from. Repeat to remove from more than one.", "hasDynamicHelp": false, "multiple": true, "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" ], "type": "option" }, "project": { "char": "p", "name": "project", "summary": "Remove project-local skills instead of global skills.", "allowNo": false, "type": "boolean" }, "force": { "name": "force", "summary": "Remove locally modified or unverified Spacefast skill files.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "skills:remove", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Remove Spacefast agent skills.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "skills", "remove.js" ], "aliasPermutations": [ "skills:rm", "rm:skills", "skills:uninstall", "uninstall:skills" ], "permutations": [ "skills:remove", "remove:skills" ] }, "skills:status": { "aliases": [ "skills:doctor" ], "args": {}, "description": "Check installed Spacefast skills against the revision bundled with this CLI.", "examples": [ { "command": "<%= config.bin %> skills status", "description": "Check all common global skill locations." }, { "command": "<%= config.bin %> skills doctor --agent codex", "description": "Check the Codex Spacefast skill location." }, { "command": "<%= config.bin %> skills status --project --agent claude-code", "description": "Check this project's Claude Code skill location." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "agent": { "name": "agent", "summary": "Agent to check. `auto` checks detected agents plus .agents/skills.", "hasDynamicHelp": false, "multiple": true, "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" ], "type": "option" }, "project": { "char": "p", "name": "project", "summary": "Check project-local skills instead of global skill directories.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "skills:status", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Check Spacefast skill installation.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "skills", "status.js" ], "aliasPermutations": [ "skills:doctor", "doctor:skills" ], "permutations": [ "skills:status", "status:skills" ] }, "source:archive": { "aliases": [], "args": {}, "description": "Download a tar.gz archive of a space's source repository.", "examples": [ { "command": "<%= config.bin %> source archive --space docs --ref main --output ./repo.tar.gz", "description": "Download a repository archive for the main ref." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "connection-type": { "helpGroup": "Repository", "name": "connection-type", "summary": "Repository connection type.", "default": "connected", "hasDynamicHelp": false, "multiple": false, "options": [ "connected", "hosted" ], "type": "option" }, "ref": { "helpGroup": "Repository", "name": "ref", "summary": "Branch, tag, commit, or ref to archive.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "output": { "helpGroup": "Repository", "name": "output", "summary": "Archive file path, or an existing directory to write the archive into.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "overwrite": { "helpGroup": "Repository", "name": "overwrite", "summary": "Overwrite an existing archive file.", "allowNo": false, "type": "boolean" }, "include-glob": { "helpGroup": "Repository", "name": "include-glob", "summary": "Glob to include in the archive.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "exclude-glob": { "helpGroup": "Repository", "name": "exclude-glob", "summary": "Glob to exclude from the archive.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "max-blob-size": { "helpGroup": "Repository", "name": "max-blob-size", "summary": "Maximum blob size to include.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "archive-prefix": { "helpGroup": "Repository", "name": "archive-prefix", "summary": "Directory prefix inside the archive.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "source:archive", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Download a repository archive.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "source", "archive.js" ], "aliasPermutations": [], "permutations": [ "source:archive", "archive:source" ] }, "source:branch": { "aliases": [], "args": {}, "description": "Create or delete an ephemeral repository branch.", "examples": [ { "command": "<%= config.bin %> source branch --branch preview/my-change --remote", "description": "Create an ephemeral branch and print a signed Git remote." }, { "command": "<%= config.bin %> source branch --branch preview/my-change --delete", "description": "Delete an ephemeral branch." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "branch": { "helpGroup": "Repository", "name": "branch", "required": true, "summary": "Ephemeral branch name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "base-ref": { "helpGroup": "Repository", "name": "base-ref", "summary": "Commit, tag, or ref to create the branch from.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "base-branch": { "helpGroup": "Repository", "name": "base-branch", "summary": "Branch to create the branch from.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "connection-type": { "helpGroup": "Repository", "name": "connection-type", "summary": "Repository connection to use.", "hasDynamicHelp": false, "multiple": false, "options": [ "connected", "hosted" ], "type": "option" }, "remote": { "helpGroup": "Repository", "name": "remote", "summary": "Also return a signed Git remote for the branch.", "allowNo": false, "type": "boolean" }, "delete": { "helpGroup": "Repository", "name": "delete", "summary": "Delete the branch instead of creating it.", "allowNo": false, "type": "boolean" }, "ttl-seconds": { "helpGroup": "Repository", "name": "ttl-seconds", "summary": "Signed remote TTL in seconds, up to 86400.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "read-only-ref": { "helpGroup": "Repository", "name": "read-only-ref", "summary": "Ref pattern to protect. Repeat for multiple patterns.", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "source:branch", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Manage ephemeral repository branches.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "source", "branch.js" ], "aliasPermutations": [], "permutations": [ "source:branch", "branch:source" ] }, "source:cat": { "aliases": [], "args": { "path": { "description": "Repository file path to print.", "name": "path", "required": true } }, "description": "Print a bounded text file from a space's source repository.", "examples": [ "<%= config.bin %> source cat README.md --space docs" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "connection-type": { "helpGroup": "Repository", "name": "connection-type", "summary": "Repository connection type.", "default": "connected", "hasDynamicHelp": false, "multiple": false, "options": [ "connected", "hosted" ], "type": "option" }, "ref": { "helpGroup": "Repository", "name": "ref", "summary": "Branch, tag, commit, or ref to inspect.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "max-bytes": { "helpGroup": "Repository", "name": "max-bytes", "summary": "Maximum bytes to read.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "source:cat", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Print a repository file.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "source", "cat.js" ], "aliasPermutations": [], "permutations": [ "source:cat", "cat:source" ] }, "source:commits:apply": { "aliases": [], "args": {}, "description": "Create a repository commit from a unified diff.", "examples": [ "<%= config.bin %> source commits apply --space docs --connection-type hosted --target-branch main --message \"Patch\" --diff ./change.patch" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "connection-type": { "helpGroup": "Repository", "name": "connection-type", "required": true, "summary": "Repository connection type.", "hasDynamicHelp": false, "multiple": false, "options": [ "connected", "hosted" ], "type": "option" }, "target-branch": { "helpGroup": "Repository", "name": "target-branch", "required": true, "summary": "Branch to update.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "message": { "helpGroup": "Repository", "name": "message", "required": true, "summary": "Commit message.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "expected-head-sha": { "helpGroup": "Repository", "name": "expected-head-sha", "summary": "Fail if the target branch no longer points at this SHA.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "base-branch": { "helpGroup": "Repository", "name": "base-branch", "summary": "Base branch for the commit.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "ephemeral": { "helpGroup": "Repository", "name": "ephemeral", "summary": "Treat the target branch as ephemeral.", "allowNo": false, "type": "boolean" }, "ephemeral-base": { "helpGroup": "Repository", "name": "ephemeral-base", "summary": "Treat the base branch as ephemeral.", "allowNo": false, "type": "boolean" }, "author-name": { "helpGroup": "Repository", "name": "author-name", "summary": "Commit author name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "author-email": { "helpGroup": "Repository", "name": "author-email", "summary": "Commit author email.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "committer-name": { "helpGroup": "Repository", "name": "committer-name", "summary": "Committer name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "committer-email": { "helpGroup": "Repository", "name": "committer-email", "summary": "Committer email.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "diff": { "helpGroup": "Repository", "name": "diff", "required": true, "summary": "Path to a unified diff file.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "source:commits:apply", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Create a repository commit from a diff.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "source", "commits", "apply.js" ], "aliasPermutations": [], "permutations": [ "source:commits:apply", "commits:source:apply", "commits:apply:source", "source:apply:commits", "apply:source:commits", "apply:commits:source" ] }, "source:commits:create": { "aliases": [], "args": {}, "description": "Create a repository commit from explicit file operations.", "examples": [ "<%= config.bin %> source commits create --space docs --connection-type hosted --target-branch main --message \"Update\" --file index.html=./index.html" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "connection-type": { "helpGroup": "Repository", "name": "connection-type", "required": true, "summary": "Repository connection type.", "hasDynamicHelp": false, "multiple": false, "options": [ "connected", "hosted" ], "type": "option" }, "target-branch": { "helpGroup": "Repository", "name": "target-branch", "required": true, "summary": "Branch to update.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "message": { "helpGroup": "Repository", "name": "message", "required": true, "summary": "Commit message.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "expected-head-sha": { "helpGroup": "Repository", "name": "expected-head-sha", "summary": "Fail if the target branch no longer points at this SHA.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "base-branch": { "helpGroup": "Repository", "name": "base-branch", "summary": "Base branch for the commit.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "ephemeral": { "helpGroup": "Repository", "name": "ephemeral", "summary": "Treat the target branch as ephemeral.", "allowNo": false, "type": "boolean" }, "ephemeral-base": { "helpGroup": "Repository", "name": "ephemeral-base", "summary": "Treat the base branch as ephemeral.", "allowNo": false, "type": "boolean" }, "author-name": { "helpGroup": "Repository", "name": "author-name", "summary": "Commit author name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "author-email": { "helpGroup": "Repository", "name": "author-email", "summary": "Commit author email.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "committer-name": { "helpGroup": "Repository", "name": "committer-name", "summary": "Committer name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "committer-email": { "helpGroup": "Repository", "name": "committer-email", "summary": "Committer email.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "file": { "helpGroup": "Repository", "name": "file", "summary": "File operation as repository-path=local-path. Repeat for multiple files.", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "delete": { "helpGroup": "Repository", "name": "delete", "summary": "Repository path to delete. Repeat for multiple paths.", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "mode": { "helpGroup": "Repository", "name": "mode", "summary": "Mode for upserted files.", "hasDynamicHelp": false, "multiple": false, "options": [ "100644", "100755", "120000", "160000" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "source:commits:create", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Create a repository commit.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "source", "commits", "create.js" ], "aliasPermutations": [], "permutations": [ "source:commits:create", "commits:source:create", "commits:create:source", "source:create:commits", "create:source:commits", "create:commits:source" ] }, "source:commits:get": { "aliases": [], "args": { "sha": { "description": "Commit SHA to inspect.", "name": "sha", "required": true } }, "description": "Read commit metadata from a space's source repository.", "examples": [ { "command": "<%= config.bin %> source commits get a1b2c3d --space docs", "description": "Read commit metadata for a SHA." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "connection-type": { "helpGroup": "Repository", "name": "connection-type", "summary": "Repository connection type.", "default": "connected", "hasDynamicHelp": false, "multiple": false, "options": [ "connected", "hosted" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "source:commits:get", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Show a repository commit.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "source", "commits", "get.js" ], "aliasPermutations": [], "permutations": [ "source:commits:get", "commits:source:get", "commits:get:source", "source:get:commits", "get:source:commits", "get:commits:source" ] }, "source:commits:ls": { "aliases": [], "args": {}, "description": "List commit history from a space's source repository.", "examples": [ { "command": "<%= config.bin %> source commits ls --space docs --branch main", "description": "List commit history for the main branch." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "connection-type": { "helpGroup": "Repository", "name": "connection-type", "summary": "Repository connection type.", "default": "connected", "hasDynamicHelp": false, "multiple": false, "options": [ "connected", "hosted" ], "type": "option" }, "branch": { "helpGroup": "Repository", "name": "branch", "summary": "Branch to list commits from.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "path": { "helpGroup": "Repository", "name": "path", "summary": "Repository path to filter commit history.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "cursor": { "helpGroup": "Repository", "name": "cursor", "summary": "Pagination cursor.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "limit": { "helpGroup": "Repository", "name": "limit", "summary": "Maximum commits to return.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "ephemeral": { "helpGroup": "Repository", "name": "ephemeral", "summary": "Treat the branch as ephemeral.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "source:commits:ls", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List repository commits.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "source", "commits", "ls.js" ], "aliasPermutations": [], "permutations": [ "source:commits:ls", "commits:source:ls", "commits:ls:source", "source:ls:commits", "ls:source:commits", "ls:commits:source" ] }, "source:diff": { "aliases": [], "args": {}, "description": "Read changed files and stats for a repository branch.", "examples": [ { "command": "<%= config.bin %> source diff --space docs --branch feature --base main", "description": "Show changed files between feature and main." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "connection-type": { "helpGroup": "Repository", "name": "connection-type", "summary": "Repository connection type.", "default": "connected", "hasDynamicHelp": false, "multiple": false, "options": [ "connected", "hosted" ], "type": "option" }, "branch": { "helpGroup": "Repository", "name": "branch", "required": true, "summary": "Branch to diff.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "base": { "helpGroup": "Repository", "name": "base", "summary": "Base branch, tag, commit, or ref.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "path": { "helpGroup": "Repository", "name": "path", "summary": "Repository path to diff.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "ephemeral": { "helpGroup": "Repository", "name": "ephemeral", "summary": "Treat the branch as ephemeral.", "allowNo": false, "type": "boolean" }, "ephemeral-base": { "helpGroup": "Repository", "name": "ephemeral-base", "summary": "Treat the base branch as ephemeral.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "source:diff", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Show a repository branch diff.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "source", "diff.js" ], "aliasPermutations": [], "permutations": [ "source:diff", "diff:source" ] }, "source:import": { "aliases": [], "args": {}, "description": "Create a signed repository import remote for one-time source ingestion.", "examples": [ { "command": "<%= config.bin %> source import", "description": "Print a signed import remote URL." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "ttl-seconds": { "helpGroup": "Repository", "name": "ttl-seconds", "summary": "Signed import remote TTL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "read-only-ref": { "helpGroup": "Repository", "name": "read-only-ref", "summary": "Ref glob to keep read-only on the signed remote. Repeat for multiple refs.", "hasDynamicHelp": false, "multiple": true, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "source:import", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Create repository import remote.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "source", "import.js" ], "aliasPermutations": [], "permutations": [ "source:import", "import:source" ] }, "source:ls": { "aliases": [], "args": {}, "description": "List files in a space's source repository.", "examples": [ { "command": "<%= config.bin %> source ls --space docs --path src --recursive", "description": "List files under src recursively." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "connection-type": { "helpGroup": "Repository", "name": "connection-type", "summary": "Repository connection type.", "default": "connected", "hasDynamicHelp": false, "multiple": false, "options": [ "connected", "hosted" ], "type": "option" }, "ref": { "helpGroup": "Repository", "name": "ref", "summary": "Branch, tag, commit, or ref to inspect.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "path": { "helpGroup": "Repository", "name": "path", "summary": "Repository directory to list.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "recursive": { "helpGroup": "Repository", "name": "recursive", "summary": "List files recursively.", "allowNo": false, "type": "boolean" }, "metadata": { "helpGroup": "Repository", "name": "metadata", "summary": "Include size and last-commit metadata.", "allowNo": false, "type": "boolean" }, "limit": { "helpGroup": "Repository", "name": "limit", "summary": "Maximum number of entries to return.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "source:ls", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List repository files.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "source", "ls.js" ], "aliasPermutations": [], "permutations": [ "source:ls", "ls:source" ] }, "source:merge": { "aliases": [], "args": { "source": { "description": "Source branch to merge from.", "name": "source", "required": true }, "target": { "description": "Target branch to merge into.", "name": "target", "required": true } }, "description": "Merge repository branches.", "examples": [ { "command": "<%= config.bin %> source merge feature main --space docs --connection-type hosted", "description": "Merge the feature branch into main." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "connection-type": { "helpGroup": "Repository", "name": "connection-type", "required": true, "summary": "Repository connection type.", "hasDynamicHelp": false, "multiple": false, "options": [ "connected", "hosted" ], "type": "option" }, "strategy": { "helpGroup": "Repository", "name": "strategy", "summary": "Merge strategy.", "default": "ff_prefer", "hasDynamicHelp": false, "multiple": false, "options": [ "merge", "ff_only", "ff_prefer" ], "type": "option" }, "source-ephemeral": { "helpGroup": "Repository", "name": "source-ephemeral", "summary": "Treat the source branch as ephemeral.", "allowNo": false, "type": "boolean" }, "target-ephemeral": { "helpGroup": "Repository", "name": "target-ephemeral", "summary": "Treat the target branch as ephemeral.", "allowNo": false, "type": "boolean" }, "expected-target-sha": { "helpGroup": "Repository", "name": "expected-target-sha", "summary": "Fail if the target branch no longer points at this SHA.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "message": { "helpGroup": "Repository", "name": "message", "summary": "Merge commit message.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "allow-unrelated-histories": { "helpGroup": "Repository", "name": "allow-unrelated-histories", "summary": "Allow merging unrelated histories.", "allowNo": false, "type": "boolean" }, "squash": { "helpGroup": "Repository", "name": "squash", "summary": "Create a squash merge.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "source:merge", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Merge repository branches.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "source", "merge.js" ], "aliasPermutations": [], "permutations": [ "source:merge", "merge:source" ] }, "source:search": { "aliases": [], "args": { "pattern": { "description": "Text or pattern to search for.", "name": "pattern", "required": true } }, "description": "Search text across a space's source repository.", "examples": [ { "command": "<%= config.bin %> source search \"TODO\" --space docs --path src", "description": "Search for TODO under src." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "connection-type": { "helpGroup": "Repository", "name": "connection-type", "summary": "Repository connection type.", "default": "connected", "hasDynamicHelp": false, "multiple": false, "options": [ "connected", "hosted" ], "type": "option" }, "ref": { "helpGroup": "Repository", "name": "ref", "summary": "Branch, tag, commit, or ref to inspect.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "path": { "helpGroup": "Repository", "name": "path", "summary": "Repository path to search.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "include-glob": { "helpGroup": "Repository", "name": "include-glob", "summary": "Glob to include in search.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "exclude-glob": { "helpGroup": "Repository", "name": "exclude-glob", "summary": "Glob to exclude from search.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "extension": { "helpGroup": "Repository", "name": "extension", "summary": "File extension filter.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "case-sensitive": { "helpGroup": "Repository", "name": "case-sensitive", "summary": "Use case-sensitive matching.", "allowNo": false, "type": "boolean" }, "context-before": { "helpGroup": "Repository", "name": "context-before", "summary": "Context lines before each match.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "context-after": { "helpGroup": "Repository", "name": "context-after", "summary": "Context lines after each match.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "max-lines": { "helpGroup": "Repository", "name": "max-lines", "summary": "Maximum matched lines to return.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "max-matches-per-file": { "helpGroup": "Repository", "name": "max-matches-per-file", "summary": "Maximum matches to return per file.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "cursor": { "helpGroup": "Repository", "name": "cursor", "summary": "Pagination cursor.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "limit": { "helpGroup": "Repository", "name": "limit", "summary": "Maximum files to return.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "source:search", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Search repository files.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "source", "search.js" ], "aliasPermutations": [], "permutations": [ "source:search", "search:source" ] }, "source:tags:create": { "aliases": [], "args": { "name": { "description": "Tag name to create.", "name": "name", "required": true } }, "description": "Create a release tag in a space's source repository.", "examples": [ { "command": "<%= config.bin %> source tags create v1.0.0 --space docs --connection-type hosted --target main", "description": "Create a release tag pointing at main." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "connection-type": { "helpGroup": "Repository", "name": "connection-type", "required": true, "summary": "Repository connection type.", "hasDynamicHelp": false, "multiple": false, "options": [ "connected", "hosted" ], "type": "option" }, "target": { "helpGroup": "Repository", "name": "target", "required": true, "summary": "Commit SHA, branch, tag, or ref the tag should point at.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "source:tags:create", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Create a repository tag.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "source", "tags", "create.js" ], "aliasPermutations": [], "permutations": [ "source:tags:create", "tags:source:create", "tags:create:source", "source:create:tags", "create:source:tags", "create:tags:source" ] }, "source:tags:ls": { "aliases": [], "args": {}, "description": "List tags in a space's source repository.", "examples": [ "<%= config.bin %> source tags ls --space docs" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "connection-type": { "helpGroup": "Repository", "name": "connection-type", "summary": "Repository connection type.", "default": "connected", "hasDynamicHelp": false, "multiple": false, "options": [ "connected", "hosted" ], "type": "option" }, "cursor": { "helpGroup": "Repository", "name": "cursor", "summary": "Pagination cursor.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "limit": { "helpGroup": "Repository", "name": "limit", "summary": "Maximum tags to return.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "source:tags:ls", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List repository tags.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "source", "tags", "ls.js" ], "aliasPermutations": [], "permutations": [ "source:tags:ls", "tags:source:ls", "tags:ls:source", "source:ls:tags", "ls:source:tags", "ls:tags:source" ] }, "spaces": { "aliases": [], "args": {}, "description": "Manage Spacefast spaces.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "spaces", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Manage spaces.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "spaces.js" ], "aliasPermutations": [], "permutations": [ "spaces" ], "examples": [ { "command": "<%= config.bin %> spaces", "description": "Manage spaces." } ] }, "spaces:add": { "aliases": [ "spaces:create" ], "args": {}, "description": "Create an empty space and save it to .spacefast/state.json.", "examples": [ "<%= config.bin %> spaces add --name docs" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "char": "n", "helpGroup": "Space metadata", "name": "name", "summary": "Set the space title.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "slug": { "helpGroup": "Space metadata", "name": "slug", "summary": "Set the space slug when creating a new space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "hostname-scope": { "helpGroup": "Space metadata", "name": "hostname-scope", "summary": "Managed hostname scope for newly created spaces.", "hasDynamicHelp": false, "multiple": false, "options": [ "team", "global" ], "type": "option" }, "spa": { "helpGroup": "Space metadata", "name": "spa", "summary": "Control single-page app fallback detection.", "default": "auto", "hasDynamicHelp": false, "multiple": false, "options": [ "auto", "true", "false" ], "type": "option" }, "mode": { "helpGroup": "Space metadata", "name": "mode", "summary": "Space serving mode.", "hasDynamicHelp": false, "multiple": false, "options": [ "website", "files" ], "type": "option" }, "save-state": { "helpGroup": "Execution", "name": "save-state", "summary": "Write the created space to .spacefast/state.json.", "allowNo": true, "type": "boolean" }, "show-secret": { "helpGroup": "Output", "name": "show-secret", "summary": "Print the access URL and claim link in JSON or non-interactive output.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "spaces:add", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Create an empty space.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "spaces", "add.js" ], "aliasPermutations": [ "spaces:create", "create:spaces" ], "permutations": [ "spaces:add", "add:spaces" ] }, "spaces:check": { "aliases": [], "args": { "name": { "description": "Space name or slug to check.", "name": "name", "required": true } }, "description": "Check whether a space slug and its managed view.fast hostname are available.", "examples": [ { "command": "<%= config.bin %> spaces check my-site --team acme", "description": "Check a space name in the acme team." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "spaces:check", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Check whether a space name is available.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "spaces", "check.js" ], "aliasPermutations": [], "permutations": [ "spaces:check", "check:spaces" ] }, "spaces:claim": { "aliases": [], "args": {}, "description": "Move a saved anonymous space into your account. Starts browser login if needed.", "examples": [ { "command": "<%= config.bin %> spaces claim", "description": "Claim the space saved in the current directory." }, { "command": "<%= config.bin %> spaces claim --space spc_xxx --claim-token sfc_xxx --team my-team", "description": "Claim a space into a specific team." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "keep-publishing": { "helpGroup": "Authentication", "name": "keep-publishing", "summary": "Keep the agent that published this space authorized to publish to it.", "allowNo": true, "type": "boolean" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "wait": { "helpGroup": "Execution", "name": "wait", "summary": "Wait until queued work finishes before returning.", "allowNo": true, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "spaces:claim", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Claim an anonymous space.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "rootHelpOrder": 4, "isESM": true, "relativePath": [ "dist", "commands", "spaces", "claim.js" ], "aliasPermutations": [], "permutations": [ "spaces:claim", "claim:spaces" ] }, "spaces:download": { "aliases": [], "args": {}, "description": "Download files from a space version. Defaults to the latest version.", "examples": [ { "command": "<%= config.bin %> spaces download --space docs --output ./out", "description": "Download the latest version's files into ./out." }, { "command": "<%= config.bin %> spaces download --space docs --version v3 --overwrite", "description": "Download version v3, overwriting existing files." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "output": { "name": "output", "summary": "Directory to write downloaded files into.", "default": ".", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "overwrite": { "name": "overwrite", "summary": "Overwrite files that already exist in the output directory.", "allowNo": false, "type": "boolean" }, "concurrency": { "char": "j", "name": "concurrency", "summary": "Number of files to download at the same time.", "default": 10, "hasDynamicHelp": false, "multiple": false, "type": "option" }, "version": { "char": "v", "name": "version", "summary": "Version ID, version ref, number, or \"latest\".", "default": "latest", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "spaces:download", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Download a space version.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "spaces", "download.js" ], "aliasPermutations": [], "permutations": [ "spaces:download", "download:spaces" ] }, "spaces:duplicate": { "aliases": [], "args": {}, "description": "Download an existing space version and publish those files as a new space.", "examples": [ { "command": "<%= config.bin %> spaces duplicate --space docs --slug docs-copy", "description": "Duplicate the docs space into a new docs-copy space." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "slug": { "helpGroup": "Duplicate target", "name": "slug", "summary": "Slug for the duplicate space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "title": { "helpGroup": "Duplicate target", "name": "title", "summary": "Title for the duplicate space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "version": { "helpGroup": "Duplicate source", "name": "version", "summary": "Version to duplicate. Defaults to the live version.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "wait": { "helpGroup": "Execution", "name": "wait", "summary": "Wait until queued work finishes before returning.", "allowNo": true, "type": "boolean" }, "wait-timeout": { "helpGroup": "Execution", "name": "wait-timeout", "summary": "Seconds to wait for the duplicate to become ready.", "default": 900, "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "spaces:duplicate", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Duplicate a space.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "spaces", "duplicate.js" ], "aliasPermutations": [], "permutations": [ "spaces:duplicate", "duplicate:spaces" ] }, "spaces:get": { "aliases": [], "args": {}, "description": "Print a space's live runtime state and current version.", "examples": [ { "command": "<%= config.bin %> spaces get", "description": "Show the space linked to the current directory." }, { "command": "<%= config.bin %> spaces get --space docs", "description": "Show a specific space by slug, ID, or URL." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "spaces:get", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Show a space.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "spaces", "get.js" ], "aliasPermutations": [], "permutations": [ "spaces:get", "get:spaces" ] }, "spaces:ls": { "aliases": [ "spaces:list" ], "args": {}, "description": "List spaces accessible to the current login, optionally filtered by team.", "examples": [ { "command": "<%= config.bin %> spaces ls", "description": "List spaces accessible to the current login." }, { "command": "<%= config.bin %> spaces ls --team acme", "description": "List spaces for a specific team." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "limit": { "name": "limit", "summary": "Maximum number of spaces to return (default 50, max 100).", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "spaces:ls", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List spaces.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "spaces", "ls.js" ], "aliasPermutations": [ "spaces:list", "list:spaces" ], "permutations": [ "spaces:ls", "ls:spaces" ] }, "spaces:rm": { "aliases": [ "spaces:remove", "spaces:delete" ], "args": {}, "description": "Take the selected space offline. Its slug, versions, and data stay retained for operator cleanup.", "examples": [ { "command": "<%= config.bin %> spaces rm --space docs", "description": "Take a space offline after confirmation." }, { "command": "<%= config.bin %> spaces rm --space docs --yes", "description": "Take a space offline without the confirmation prompt." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "wait": { "helpGroup": "Execution", "name": "wait", "summary": "Wait until queued work finishes before returning.", "allowNo": true, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "spaces:rm", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Take a space offline.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "spaces", "rm.js" ], "aliasPermutations": [ "spaces:remove", "remove:spaces", "spaces:delete", "delete:spaces" ], "permutations": [ "spaces:rm", "rm:spaces" ] }, "spaces:rotate-claim": { "aliases": [], "args": {}, "description": "Replace an anonymous space's key, live URL, and claim link without changing recipient Links.", "examples": [ { "command": "<%= config.bin %> spaces rotate-claim", "description": "Rotate the anonymous Space saved in the current directory." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "spaces:rotate-claim", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Rotate an anonymous Space's key.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "spaces", "rotate-claim.js" ], "aliasPermutations": [], "permutations": [ "spaces:rotate-claim", "rotate-claim:spaces" ] }, "spaces:transfer": { "aliases": [], "args": { "team": { "description": "Target team slug, ID, or name.", "name": "team", "required": true } }, "description": "Request a transfer of the selected space to another team. It applies once the target team accepts.", "examples": [ "<%= config.bin %> spaces transfer acme --space spc_123" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "spaces:transfer", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Transfer a space to another team.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "spaces", "transfer.js" ], "aliasPermutations": [], "permutations": [ "spaces:transfer", "transfer:spaces" ] }, "spaces:update": { "aliases": [], "args": {}, "description": "Patch space identity, serving metadata, and generated viewer metadata.", "examples": [ { "command": "<%= config.bin %> spaces update --space docs --slug developers --wait", "description": "Rename the space and its managed view.fast hostname." }, { "command": "<%= config.bin %> spaces update --space docs --name \"Developer docs\"", "description": "Change the space title." }, { "command": "<%= config.bin %> spaces update --space docs --mode files --spa false", "description": "Switch serving mode to files and disable SPA fallback." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "wait": { "helpGroup": "Execution", "name": "wait", "summary": "Wait until queued work finishes before returning.", "allowNo": true, "type": "boolean" }, "wait-timeout": { "helpGroup": "Execution", "name": "wait-timeout", "summary": "Seconds to wait for queued work to finish before giving up.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "mode": { "helpGroup": "Space metadata", "name": "mode", "summary": "Serving mode.", "hasDynamicHelp": false, "multiple": false, "options": [ "website", "files" ], "type": "option" }, "spa": { "helpGroup": "Space metadata", "name": "spa", "summary": "Enable or disable SPA fallback. `auto` leaves the current setting unchanged.", "hasDynamicHelp": false, "multiple": false, "options": [ "auto", "true", "false" ], "type": "option" }, "noindex": { "helpGroup": "Space metadata", "name": "noindex", "summary": "Ask search engines not to index the live space. Pass false to allow indexing.", "hasDynamicHelp": false, "multiple": false, "options": [ "true", "false" ], "type": "option" }, "slug": { "helpGroup": "Identity", "name": "slug", "summary": "New space slug. Must be sent without other update flags.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "char": "n", "helpGroup": "Space metadata", "name": "name", "summary": "Space title.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "viewer-description": { "helpGroup": "Viewer metadata", "name": "viewer-description", "summary": "Social preview description. Pass null to clear.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "viewer-og-image-path": { "helpGroup": "Viewer metadata", "name": "viewer-og-image-path", "summary": "Social preview image path. Pass null to clear.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "viewer-title": { "helpGroup": "Viewer metadata", "name": "viewer-title", "summary": "Viewer page title. Pass null to clear.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "spaces:update", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Rename or update a space.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "spaces", "update.js" ], "aliasPermutations": [], "permutations": [ "spaces:update", "update:spaces" ] }, "status": { "aliases": [], "args": {}, "description": "Show authenticated user, default team, and the space the current directory is linked to.", "examples": [ { "command": "<%= config.bin %> status", "description": "Show login, default team, and the linked space." }, { "command": "<%= config.bin %> status --include-claim-url", "description": "Include the still-pending claim link." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "include-claim-url": { "helpGroup": "Output", "name": "include-claim-url", "summary": "Include the still-pending claim link.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "status", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Show CLI status.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "rootHelpOrder": 1, "isESM": true, "relativePath": [ "dist", "commands", "status.js" ], "aliasPermutations": [], "permutations": [ "status" ] }, "storage": { "aliases": [], "args": { "target": { "description": "Space ID, slug, live URL, or domain. Defaults to the linked space.", "name": "target", "required": false } }, "description": "List object metadata and quota usage for files uploaded by a space's app.", "examples": [ { "command": "<%= config.bin %> storage", "description": "List the linked space's objects." }, { "command": "<%= config.bin %> storage docs --limit 10", "description": "List the first ten objects in space `docs`." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "limit": { "name": "limit", "summary": "Maximum objects to return (default 50, max 100).", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "cursor": { "name": "cursor", "summary": "Continue from an opaque cursor returned by the last page.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "storage", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List a space's stored objects.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "storage.js" ], "aliasPermutations": [], "permutations": [ "storage" ] }, "storage:ls": { "aliases": [ "storage:list" ], "args": { "target": { "description": "Space ID, slug, live URL, or domain. Defaults to the linked space.", "name": "target", "required": false } }, "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "limit": { "name": "limit", "summary": "Maximum objects to return (default 50, max 100).", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "cursor": { "name": "cursor", "summary": "Continue from an opaque cursor returned by the last page.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "storage:ls", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List a space's stored objects.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "storage", "ls.js" ], "aliasPermutations": [ "storage:list", "list:storage" ], "permutations": [ "storage:ls", "ls:storage" ], "examples": [ { "command": "<%= config.bin %> storage ls [target]", "description": "List a space's stored objects." } ] }, "storage:rm": { "aliases": [ "storage:remove", "storage:delete" ], "args": { "id": { "description": "Object id, for example 0123456789abcdef0123456789abcdef.", "name": "id", "required": false } }, "description": "Force-delete an app storage object as the space owner, regardless of who uploaded it.", "examples": [ { "command": "<%= config.bin %> storage rm 0123456789abcdef0123456789abcdef --yes", "description": "Delete a stored object without prompting." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "storage:rm", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Delete a stored object.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "storage", "rm.js" ], "aliasPermutations": [ "storage:remove", "remove:storage", "storage:delete", "delete:storage" ], "permutations": [ "storage:rm", "rm:storage" ] }, "switch": { "aliases": [], "args": { "team": { "description": "Team slug, ID, or name.", "name": "team", "required": false } }, "description": "Set the default team for future CLI commands.", "examples": [ { "command": "<%= config.bin %> switch acme", "description": "Set acme as the default team for future commands." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "switch", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Switch teams.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "switch.js" ], "aliasPermutations": [], "permutations": [ "switch" ] }, "tags": { "aliases": [], "args": {}, "description": "Read the current released effective tags for a space.", "examples": [ { "command": "<%= config.bin %> tags --space docs", "description": "Show the current released effective tags." }, { "command": "<%= config.bin %> tags --space docs --environment production", "description": "Show effective tags for the production environment." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "environment": { "name": "environment", "summary": "Release environment to inspect.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "tags", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List effective tags.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "tags.js" ], "aliasPermutations": [], "permutations": [ "tags" ] }, "tags:apply": { "aliases": [], "args": { "file": { "description": "spacefast.tags.json file.", "name": "file", "required": true } }, "description": "Apply a declarative tag config by creating/updating a draft, validating, and optionally submitting or releasing.", "examples": [ { "command": "<%= config.bin %> tags apply spacefast.tags.json --space docs", "description": "Apply a declarative tag config as a draft." }, { "command": "<%= config.bin %> tags apply spacefast.tags.json --space docs --submit --release production", "description": "Apply, submit, and release to production when policy allows." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "title": { "name": "title", "summary": "Draft title.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "message": { "char": "m", "name": "message", "summary": "Draft or submission message.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "submit": { "name": "submit", "summary": "Submit after validation when policy allows.", "allowNo": false, "type": "boolean" }, "release": { "name": "release", "summary": "Release environment after approval policy allows.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "expected-current-revision": { "name": "expected-current-revision", "summary": "Optimistic release current revision check.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "idempotency-key": { "name": "idempotency-key", "summary": "Idempotency key for replay-safe apply.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "tags:apply", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Apply declarative tags.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "tags", "apply.js" ], "aliasPermutations": [], "permutations": [ "tags:apply", "apply:tags" ] }, "tags:debug": { "aliases": [], "args": {}, "description": "Create a signed no-store tag preview/debug session.", "examples": [ { "command": "<%= config.bin %> tags debug --space docs --url https://docs.view.fast", "description": "Create a signed tag debug session for a page." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "revision": { "name": "revision", "summary": "Tag revision ID to debug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "revoke-session": { "name": "revoke-session", "summary": "Preview/debug session ID to revoke.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "url": { "name": "url", "summary": "Page URL to open in debug mode.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "environment": { "name": "environment", "summary": "Release environment to debug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "idempotency-key": { "name": "idempotency-key", "summary": "Idempotency key for replay-safe debug sessions.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "tags:debug", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Create a tag debug session.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "tags", "debug.js" ], "aliasPermutations": [], "permutations": [ "tags:debug", "debug:tags" ] }, "tags:releases": { "aliases": [], "args": {}, "description": "List tag release pointers for this space.", "examples": [ { "command": "<%= config.bin %> tags releases --space docs", "description": "List tag release pointers for the space." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "tags:releases", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List tag releases.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "tags", "releases.js" ], "aliasPermutations": [], "permutations": [ "tags:releases", "releases:tags" ] }, "tags:releases:get": { "aliases": [], "args": { "environment": { "description": "Release environment, for example production.", "name": "environment", "required": true } }, "description": "Read one tag release pointer.", "examples": [ { "command": "<%= config.bin %> tags releases get production --space docs", "description": "Read the production tag release pointer." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "tags:releases:get", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Read a tag release.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "tags", "releases", "get.js" ], "aliasPermutations": [], "permutations": [ "tags:releases:get", "releases:tags:get", "releases:get:tags", "tags:get:releases", "get:tags:releases", "get:releases:tags" ] }, "tags:releases:rollback": { "aliases": [], "args": { "environment": { "description": "Release environment, for example production.", "name": "environment", "required": true }, "revision": { "description": "Prior published tag revision ID to restore.", "name": "revision", "required": true } }, "description": "Move a tag release pointer back to a prior published revision.", "examples": [ { "command": "<%= config.bin %> tags releases rollback production tver_123 --space docs", "description": "Roll the production tag release back to a prior revision." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "expected-current-revision": { "name": "expected-current-revision", "summary": "Optimistic current revision check.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "notes": { "name": "notes", "summary": "Rollback notes.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "idempotency-key": { "name": "idempotency-key", "summary": "Idempotency key for replay-safe rollback.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "tags:releases:rollback", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Roll back a tag release.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "tags", "releases", "rollback.js" ], "aliasPermutations": [], "permutations": [ "tags:releases:rollback", "releases:tags:rollback", "releases:rollback:tags", "tags:rollback:releases", "rollback:tags:releases", "rollback:releases:tags" ] }, "tags:releases:set": { "aliases": [], "args": { "environment": { "description": "Release environment, for example production.", "name": "environment", "required": true }, "revision": { "description": "Approved tag revision ID to release.", "name": "revision", "required": true } }, "description": "Point a tag release environment at an approved immutable revision.", "examples": [ { "command": "<%= config.bin %> tags releases set production tver_123 --space docs", "description": "Point the production tag release at an approved revision." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "expected-current-revision": { "name": "expected-current-revision", "summary": "Optimistic current revision check.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "notes": { "name": "notes", "summary": "Release notes.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "idempotency-key": { "name": "idempotency-key", "summary": "Idempotency key for replay-safe release.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "tags:releases:set", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Set a tag release.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "tags", "releases", "set.js" ], "aliasPermutations": [], "permutations": [ "tags:releases:set", "releases:tags:set", "releases:set:tags", "tags:set:releases", "set:tags:releases", "set:releases:tags" ] }, "tags:revisions": { "aliases": [], "args": {}, "description": "List draft, in-review, approved, published, and abandoned tag revisions.", "examples": [ { "command": "<%= config.bin %> tags revisions --space docs", "description": "List tag revisions for the space." }, { "command": "<%= config.bin %> tags revisions --space docs --status draft", "description": "List draft tag revisions." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "status": { "name": "status", "summary": "Filter by revision status.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "cursor": { "name": "cursor", "summary": "Pagination cursor.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "limit": { "name": "limit", "summary": "Maximum number of revisions to return.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "tags:revisions", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List tag revisions.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "tags", "revisions.js" ], "aliasPermutations": [], "permutations": [ "tags:revisions", "revisions:tags" ] }, "tags:revisions:abandon": { "aliases": [], "args": { "revision": { "description": "Tag revision ID.", "name": "revision", "required": true } }, "description": "Abandon a mutable tag revision.", "examples": [ "<%= config.bin %> tags revisions abandon tver_123 --space docs" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "idempotency-key": { "name": "idempotency-key", "summary": "Idempotency key for replay-safe abandon.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "tags:revisions:abandon", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Abandon a tag revision.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "tags", "revisions", "abandon.js" ], "aliasPermutations": [], "permutations": [ "tags:revisions:abandon", "revisions:tags:abandon", "revisions:abandon:tags", "tags:abandon:revisions", "abandon:tags:revisions", "abandon:revisions:tags" ] }, "tags:revisions:approve": { "aliases": [], "args": { "revision": { "description": "Tag revision ID.", "name": "revision", "required": true } }, "description": "Approve a tag revision after validation and policy gates pass.", "examples": [ "<%= config.bin %> tags revisions approve tver_123 --space docs" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "idempotency-key": { "name": "idempotency-key", "summary": "Idempotency key for replay-safe approval.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "tags:revisions:approve", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Approve a tag revision.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "tags", "revisions", "approve.js" ], "aliasPermutations": [], "permutations": [ "tags:revisions:approve", "revisions:tags:approve", "revisions:approve:tags", "tags:approve:revisions", "approve:tags:revisions", "approve:revisions:tags" ] }, "tags:revisions:create": { "aliases": [ "tags:revisions:add" ], "args": {}, "description": "Create a mutable draft tag revision from a release, base revision, or graph body.", "examples": [ { "command": "<%= config.bin %> tags revisions create --space docs --title \"Add GA\"", "description": "Create a draft tag revision." }, { "command": "<%= config.bin %> tags revisions create --space docs --template google-analytics --field measurementId=G-123", "description": "Create a draft from a built-in template." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "title": { "name": "title", "summary": "Draft title.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "message": { "char": "m", "name": "message", "summary": "Draft changelog or description.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "base-revision": { "name": "base-revision", "summary": "Base tag revision ID.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "input": { "char": "i", "name": "input", "summary": "JSON body: literal JSON, @file, or - for stdin.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "template": { "name": "template", "summary": "Built-in template ID to add, for example google-analytics or segment.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "field": { "name": "field", "summary": "Template field as key=value. Repeat for multiple fields.", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "trigger": { "name": "trigger", "summary": "Template trigger preset. Repeat for multiple triggers.", "hasDynamicHelp": false, "multiple": true, "type": "option" }, "tag-id": { "name": "tag-id", "summary": "Stable tag ID for the generated template tag.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "name": { "name": "name", "summary": "Display name for the generated template tag.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "idempotency-key": { "name": "idempotency-key", "summary": "Idempotency key for replay-safe creation.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "tags:revisions:create", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Create a tag revision.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "tags", "revisions", "create.js" ], "aliasPermutations": [ "tags:revisions:add", "revisions:tags:add", "revisions:add:tags", "tags:add:revisions", "add:tags:revisions", "add:revisions:tags" ], "permutations": [ "tags:revisions:create", "revisions:tags:create", "revisions:create:tags", "tags:create:revisions", "create:tags:revisions", "create:revisions:tags" ] }, "tags:revisions:diff": { "aliases": [], "args": { "revision": { "description": "Tag revision ID.", "name": "revision", "required": true } }, "description": "Show the generated change set from this tag revision's base revision.", "examples": [ { "command": "<%= config.bin %> tags revisions diff tver_123 --space docs", "description": "Show a tag revision's change set from its base." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "tags:revisions:diff", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Diff a tag revision.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "tags", "revisions", "diff.js" ], "aliasPermutations": [], "permutations": [ "tags:revisions:diff", "revisions:tags:diff", "revisions:diff:tags", "tags:diff:revisions", "diff:tags:revisions", "diff:revisions:tags" ] }, "tags:revisions:submit": { "aliases": [], "args": { "revision": { "description": "Tag revision ID.", "name": "revision", "required": true } }, "description": "Submit a mutable tag revision for review.", "examples": [ { "command": "<%= config.bin %> tags revisions submit tver_123 --space docs", "description": "Submit a tag revision for review." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "idempotency-key": { "name": "idempotency-key", "summary": "Idempotency key for replay-safe submit.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "tags:revisions:submit", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Submit a tag revision.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "tags", "revisions", "submit.js" ], "aliasPermutations": [], "permutations": [ "tags:revisions:submit", "revisions:tags:submit", "revisions:submit:tags", "tags:submit:revisions", "submit:tags:revisions", "submit:revisions:tags" ] }, "tags:revisions:validate": { "aliases": [], "args": { "revision": { "description": "Tag revision ID.", "name": "revision", "required": true } }, "description": "Validate a tag revision's graph, consent policy, CSP impact, limits, and review gates.", "examples": [ { "command": "<%= config.bin %> tags revisions validate tver_123 --space docs", "description": "Validate a tag revision before approval." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "idempotency-key": { "name": "idempotency-key", "summary": "Idempotency key for replay-safe validation.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "tags:revisions:validate", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Validate a tag revision.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "tags", "revisions", "validate.js" ], "aliasPermutations": [], "permutations": [ "tags:revisions:validate", "revisions:tags:validate", "revisions:validate:tags", "tags:validate:revisions", "validate:tags:revisions", "validate:revisions:tags" ] }, "tags:templates": { "aliases": [], "args": {}, "description": "List built-in tag templates and event trigger presets.", "examples": [ { "command": "<%= config.bin %> tags templates", "description": "List built-in tag templates and trigger presets." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "tags:templates", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List tag templates.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "tags", "templates.js" ], "aliasPermutations": [], "permutations": [ "tags:templates", "templates:tags" ] }, "teams": { "aliases": [], "args": {}, "description": "Manage teams and members.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "teams", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Manage teams.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "teams.js" ], "aliasPermutations": [], "permutations": [ "teams" ], "examples": [ { "command": "<%= config.bin %> teams", "description": "Manage teams." } ] }, "teams:accept": { "aliases": [], "args": { "invitation": { "description": "Invitation id from the invite link.", "name": "invitation", "required": true } }, "description": "Accept a team invitation and join the team as the current login.", "examples": [ "<%= config.bin %> teams accept inv_123" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "teams:accept", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Accept a team invitation.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "teams", "accept.js" ], "aliasPermutations": [], "permutations": [ "teams:accept", "accept:teams" ] }, "teams:create": { "aliases": [ "teams:add" ], "args": { "name": { "description": "Display name for the new team.", "name": "name", "required": true } }, "description": "Create a new team owned by the current login.", "examples": [ { "command": "<%= config.bin %> teams create \"Acme Inc\"", "description": "Create a new team." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "teams:create", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Create a team.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "teams", "create.js" ], "aliasPermutations": [ "teams:add", "add:teams" ], "permutations": [ "teams:create", "create:teams" ] }, "teams:defaults": { "aliases": [], "args": { "rootAccess": { "description": "Future Space Grant preset: private, team, or public.", "name": "rootAccess", "required": false } }, "description": "Show or set the Grant preset materialized for Spaces this team creates in the future.", "examples": [ { "command": "<%= config.bin %> teams defaults", "description": "Show the team's future-space default." }, { "command": "<%= config.bin %> teams defaults private", "description": "Make future spaces private by default." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "teams:defaults", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Manage future-space defaults.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "teams", "defaults.js" ], "aliasPermutations": [], "permutations": [ "teams:defaults", "defaults:teams" ] }, "teams:invitations": { "aliases": [], "args": {}, "description": "Manage team invitations.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "teams:invitations", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Manage team invitations.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "teams", "invitations.js" ], "aliasPermutations": [], "permutations": [ "teams:invitations", "invitations:teams" ], "examples": [ { "command": "<%= config.bin %> teams invitations", "description": "Manage team invitations." } ] }, "teams:invitations:add": { "aliases": [ "teams:invitations:create" ], "args": { "emails": { "description": "Email addresses to invite.", "multiple": true, "name": "emails", "required": true } }, "description": "Invite one or more people to a team.", "examples": [ { "command": "<%= config.bin %> teams invitations add jane@example.com alex@example.com --role member", "description": "Invite multiple members to the team." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "role": { "name": "role", "summary": "Role to grant when the invitation is accepted.", "default": "member", "hasDynamicHelp": false, "multiple": false, "options": [ "owner", "admin", "member" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "teams:invitations:add", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Create team invitations.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "teams", "invitations", "add.js" ], "aliasPermutations": [ "teams:invitations:create", "invitations:teams:create", "invitations:create:teams", "teams:create:invitations", "create:teams:invitations", "create:invitations:teams" ], "permutations": [ "teams:invitations:add", "invitations:teams:add", "invitations:add:teams", "teams:add:invitations", "add:teams:invitations", "add:invitations:teams" ] }, "teams:invitations:cancel": { "aliases": [], "args": { "invitation": { "description": "Invitation id.", "name": "invitation", "required": true } }, "description": "Cancel a team invitation.", "examples": [ "<%= config.bin %> teams invitations cancel inv_123" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "teams:invitations:cancel", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Cancel a team invitation.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "teams", "invitations", "cancel.js" ], "aliasPermutations": [], "permutations": [ "teams:invitations:cancel", "invitations:teams:cancel", "invitations:cancel:teams", "teams:cancel:invitations", "cancel:teams:invitations", "cancel:invitations:teams" ] }, "teams:invitations:ls": { "aliases": [ "teams:invitations:list" ], "args": {}, "description": "List pending and historical team invitations.", "examples": [ "<%= config.bin %> teams invitations ls" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "teams:invitations:ls", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List team invitations.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "teams", "invitations", "ls.js" ], "aliasPermutations": [ "teams:invitations:list", "invitations:teams:list", "invitations:list:teams", "teams:list:invitations", "list:teams:invitations", "list:invitations:teams" ], "permutations": [ "teams:invitations:ls", "invitations:teams:ls", "invitations:ls:teams", "teams:ls:invitations", "ls:teams:invitations", "ls:invitations:teams" ] }, "teams:invitations:resend": { "aliases": [], "args": { "invitation": { "description": "Invitation id.", "name": "invitation", "required": true } }, "description": "Resend a pending team invitation.", "examples": [ "<%= config.bin %> teams invitations resend inv_123" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "teams:invitations:resend", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Resend a team invitation.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "teams", "invitations", "resend.js" ], "aliasPermutations": [], "permutations": [ "teams:invitations:resend", "invitations:teams:resend", "invitations:resend:teams", "teams:resend:invitations", "resend:teams:invitations", "resend:invitations:teams" ] }, "teams:ls": { "aliases": [ "teams:list" ], "args": {}, "description": "List teams available to the current login.", "examples": [ "<%= config.bin %> teams ls" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "teams:ls", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List teams.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "teams", "ls.js" ], "aliasPermutations": [ "teams:list", "list:teams" ], "permutations": [ "teams:ls", "ls:teams" ] }, "teams:members": { "aliases": [], "args": {}, "description": "Manage team members.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "teams:members", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Manage team members.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "teams", "members.js" ], "aliasPermutations": [], "permutations": [ "teams:members", "members:teams" ], "examples": [ { "command": "<%= config.bin %> teams members", "description": "Manage team members." } ] }, "teams:members:ls": { "aliases": [ "teams:members:list" ], "args": {}, "description": "List members in a team.", "examples": [ "<%= config.bin %> teams members ls" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "teams:members:ls", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List team members.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "teams", "members", "ls.js" ], "aliasPermutations": [ "teams:members:list", "members:teams:list", "members:list:teams", "teams:list:members", "list:teams:members", "list:members:teams" ], "permutations": [ "teams:members:ls", "members:teams:ls", "members:ls:teams", "teams:ls:members", "ls:teams:members", "ls:members:teams" ] }, "teams:members:rm": { "aliases": [ "teams:members:remove", "teams:members:delete" ], "args": { "member": { "description": "Member id or email.", "name": "member", "required": true } }, "description": "Remove a member from a team.", "examples": [ "<%= config.bin %> teams members rm jane@example.com" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "teams:members:rm", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Remove a team member.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "teams", "members", "rm.js" ], "aliasPermutations": [ "teams:members:remove", "members:teams:remove", "members:remove:teams", "teams:remove:members", "remove:teams:members", "remove:members:teams", "teams:members:delete", "members:teams:delete", "members:delete:teams", "teams:delete:members", "delete:teams:members", "delete:members:teams" ], "permutations": [ "teams:members:rm", "members:teams:rm", "members:rm:teams", "teams:rm:members", "rm:teams:members", "rm:members:teams" ] }, "teams:switch": { "aliases": [], "args": { "team": { "description": "Team slug, ID, or name.", "name": "team", "required": false } }, "description": "Set the default team for future CLI publishes.", "examples": [ { "command": "<%= config.bin %> teams switch acme", "description": "Set acme as the default team." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "teams:switch", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Set default team.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "teams", "switch.js" ], "aliasPermutations": [], "permutations": [ "teams:switch", "switch:teams" ] }, "transfers:accept": { "aliases": [ "transfers:confirm" ], "args": { "id": { "description": "Transfer ID.", "name": "id", "required": true } }, "description": "Accept a pending space transfer as a member of the target team.", "examples": [ { "command": "<%= config.bin %> transfers accept trf_123", "description": "Accept a pending space transfer." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "transfers:accept", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Accept a space transfer.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "transfers", "accept.js" ], "aliasPermutations": [ "transfers:confirm", "confirm:transfers" ], "permutations": [ "transfers:accept", "accept:transfers" ] }, "transfers:cancel": { "aliases": [], "args": { "id": { "description": "Transfer ID.", "name": "id", "required": true } }, "description": "Cancel a pending space transfer.", "examples": [ "<%= config.bin %> transfers cancel trf_123" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "transfers:cancel", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Cancel a space transfer.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "transfers", "cancel.js" ], "aliasPermutations": [], "permutations": [ "transfers:cancel", "cancel:transfers" ] }, "unlink": { "aliases": [], "args": {}, "description": "Remove this checkout's Spacefast link and private local publish state.", "examples": [ { "command": "<%= config.bin %> unlink", "description": "Review and remove the nearest checkout link." }, { "command": "<%= config.bin %> unlink --yes --json", "description": "Remove the link non-interactively and print the removed files." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "unlink", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Unlink this checkout from its space.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "unlink.js" ], "aliasPermutations": [], "permutations": [ "unlink" ] }, "versions": { "aliases": [], "args": {}, "description": "List, promote, and roll back space versions.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "versions", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Manage versions.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "rootHelpOrder": 2, "isESM": true, "relativePath": [ "dist", "commands", "versions.js" ], "aliasPermutations": [], "permutations": [ "versions" ], "examples": [ { "command": "<%= config.bin %> versions", "description": "Manage versions." } ] }, "versions:get": { "aliases": [], "args": { "version": { "description": "Version ID, ref, or number, for example ver_123, v12, or 12.", "name": "version", "required": false } }, "description": "Show one version's status, source, Version URL, diagnostics, and failure details.", "examples": [ { "command": "<%= config.bin %> versions get v12", "description": "Inspect version v12 of the linked space." }, { "command": "<%= config.bin %> versions get ver_123 --space docs --json", "description": "Print a version of a selected space as JSON." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "versions:get", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Show a version.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "versions", "get.js" ], "aliasPermutations": [], "permutations": [ "versions:get", "get:versions" ] }, "versions:ls": { "aliases": [ "versions:list" ], "args": {}, "description": "List space versions, marking the live one and any still publishing.", "examples": [ { "command": "<%= config.bin %> versions ls", "description": "List versions for the linked space." }, { "command": "<%= config.bin %> versions ls --space docs", "description": "List versions for a specific space." }, { "command": "<%= config.bin %> versions ls --commit $(git rev-parse HEAD)", "description": "Find the version published from a commit." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "commit": { "description": "Full 40-character git commit SHA. Short SHAs are rejected — the match is exact.", "name": "commit", "summary": "Only versions published from this commit.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "versions:ls", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List space versions.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "versions", "ls.js" ], "aliasPermutations": [ "versions:list", "list:versions" ], "permutations": [ "versions:ls", "ls:versions" ] }, "versions:rm": { "aliases": [ "versions:remove", "versions:delete" ], "args": { "version": { "description": "Version ID, ref, or number, for example ver_123, v12, or 12.", "name": "version", "required": false } }, "description": "Delete a version and purge its files. Versions referenced by a channel (live) cannot be deleted; promote another version first. The version URL starts serving a tombstone.", "examples": [ { "command": "<%= config.bin %> versions rm v12", "description": "Delete version v12 of the linked space." }, { "command": "<%= config.bin %> versions rm ver_123 --space docs --yes", "description": "Delete without a confirmation prompt." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "versions:rm", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Delete a version.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "versions", "rm.js" ], "aliasPermutations": [ "versions:remove", "remove:versions", "versions:delete", "delete:versions" ], "permutations": [ "versions:rm", "rm:versions" ] }, "whoami": { "aliases": [], "args": {}, "description": "Verify the active token and print the authenticated account.", "examples": [ { "command": "<%= config.bin %> whoami", "description": "Show the authenticated account." }, { "command": "<%= config.bin %> whoami --json", "description": "Print the account as JSON for scripting." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "whoami", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Show the current Spacefast account.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "whoami.js" ], "aliasPermutations": [], "permutations": [ "whoami" ] }, "wp": { "aliases": [], "args": {}, "description": "Runs WP-CLI against a space's WordPress, or against a local one with --local. Everything after the flags is passed to `wp` unchanged, so `sf wp plugin list --format=csv` runs exactly that. WP-CLI's own output and exit code pass through untouched; `--json` wraps only Spacefast's own errors, never `wp`'s output. Use `--` to pass a flag `sf` would otherwise read as its own, as in `sf wp -- --version`.", "examples": [ { "command": "<%= config.bin %> wp option get blogname", "description": "Read an option." }, { "command": "<%= config.bin %> wp --space docs plugin list --format=csv", "description": "Run against a named space; `--format` reaches `wp`." }, { "command": "<%= config.bin %> wp --local --path ./wordpress core version", "description": "Run against a local WordPress instead." }, { "command": "<%= config.bin %> wp -- --version", "description": "Pass a flag `sf` would otherwise claim." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "local": { "helpGroup": "Runtime", "name": "local", "summary": "Run against a local WordPress instead of the space's.", "allowNo": false, "type": "boolean" }, "path": { "helpGroup": "Runtime", "name": "path", "summary": "Path to the local WordPress install; implies --local.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "mode": { "helpGroup": "Runtime", "name": "mode", "summary": "Remote only. `limited` skips the site's own themes and plugins, so a core command still answers on a broken site.", "default": "full", "hasDynamicHelp": false, "multiple": false, "options": [ "full", "limited" ], "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "wp", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": false, "summary": "Run a WP-CLI command.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "wp.js" ], "aliasPermutations": [], "permutations": [ "wp" ] }, "zero": { "aliases": [], "args": {}, "description": "Inspect and call the Abilities a space's Zero capsule publishes, and move a Payload CMS or EmDash project onto Zero.", "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "zero", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Work with a space's Zero capsule.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "zero.js" ], "aliasPermutations": [], "permutations": [ "zero" ], "examples": [ { "command": "<%= config.bin %> zero", "description": "Work with a space's Zero capsule." } ] }, "zero:abilities": { "aliases": [ "zero:ls" ], "args": {}, "description": "List the Abilities the space's live capsule publishes: what an agent can call, what category it belongs to, and whether it reads or writes.", "examples": [ { "command": "<%= config.bin %> zero abilities", "description": "List the Abilities the live version publishes." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "zero:abilities", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "List a space's Zero Abilities.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "zero", "abilities.js" ], "aliasPermutations": [ "zero:ls", "ls:zero" ], "permutations": [ "zero:abilities", "abilities:zero" ] }, "zero:call": { "aliases": [], "args": { "ability": { "description": "Ability name, as shown by `sf zero abilities`.", "name": "ability", "required": true } }, "description": "Mint a short-lived Ability token for the space and run the Ability against the space's own WordPress REST API. The token is never printed and never appears in the --json receipt.", "examples": [ { "command": "<%= config.bin %> zero call content.posts.list", "description": "Run a read Ability with no input." }, { "command": "<%= config.bin %> zero call content.posts.get --input '{\"slug\":\"hello\"}'", "description": "Pass the Ability's input as inline JSON." }, { "command": "<%= config.bin %> zero call content.posts.save --input @post.json", "description": "Read the input from a JSON file." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "credential": { "helpGroup": "Authentication", "name": "credential", "summary": "Machine credential id to mint the Ability token for. Optional when the space has exactly one.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "input": { "name": "input", "summary": "Ability input as inline JSON, or @path to read it from a file.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "zero:call", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Call one of a space's Zero Abilities.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "zero", "call.js" ], "aliasPermutations": [], "permutations": [ "zero:call", "call:zero" ] }, "zero:import": { "aliases": [], "args": { "source": { "description": "Project format to translate: payloadcms or emdash.", "name": "source", "required": true }, "directory": { "description": "Directory holding the project to translate.", "name": "directory", "required": true } }, "description": "Translate a foreign CMS project into an authored Zero capsule and its content files. Prints the translation report: a Payload config with anything Zero cannot hold is refused outright and nothing is written.", "examples": [ { "command": "<%= config.bin %> zero import payloadcms ../my-payload-app", "description": "Translate a Payload CMS config into a capsule in this directory." }, { "command": "<%= config.bin %> zero import emdash ../my-emdash-site --out .", "description": "Translate an EmDash seed, writing its Markdown content alongside the capsule." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "out": { "name": "out", "summary": "Directory to write the capsule and content into. Defaults to the current directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "capsule": { "name": "capsule", "summary": "Capsule module to write, relative to --out. Defaults to server/index.ts.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "force": { "name": "force", "summary": "Overwrite files the import would otherwise refuse to replace.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "zero:import", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Import a Payload CMS or EmDash project as a Zero capsule.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "zero", "import.js" ], "aliasPermutations": [], "permutations": [ "zero:import", "import:zero" ] }, "zero:types": { "aliases": [], "args": {}, "description": "Generate TypeScript for everything the platform owns rather than your source: the live content model's types, the Ability catalog with the capability each one needs, and a row type per database table. Commit the result and use --check in CI to catch types that no longer describe the space.", "examples": [ { "command": "<%= config.bin %> zero types", "description": "Write zero-types.ts from what the space publishes right now." }, { "command": "<%= config.bin %> zero types --check", "description": "Fail if the committed types no longer match the space." } ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "api-url": { "env": "SPACEFAST_API_URL", "helpGroup": "GLOBAL", "name": "api-url", "summary": "Spacefast API base URL.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "profile": { "env": "SPACEFAST_PROFILE", "helpGroup": "GLOBAL", "name": "profile", "summary": "Named provider profile from `sf profiles`.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "token": { "env": "SPACEFAST_TOKEN", "helpGroup": "Authentication", "name": "token", "noCacheDefault": true, "summary": "API key for non-interactive auth.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "yes": { "char": "y", "env": "SPACEFAST_YES", "helpGroup": "GLOBAL", "name": "yes", "summary": "Skip confirmation prompts.", "allowNo": false, "type": "boolean" }, "claim-token": { "env": "SPACEFAST_CLAIM_TOKEN", "helpGroup": "Authentication", "name": "claim-token", "noCacheDefault": true, "summary": "Space key (sfc_…) for an unclaimed anonymous space.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "team": { "char": "o", "env": "SPACEFAST_TEAM", "helpGroup": "Space selection", "name": "team", "summary": "Team slug, ID, or name.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "space": { "env": "SPACEFAST_SPACE", "helpGroup": "Space selection", "name": "space", "summary": "Space ID, live URL, domain, or slug.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "out": { "helpGroup": "Output", "name": "out", "summary": "File to write, relative to the current directory. Defaults to zero-types.ts.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "check": { "helpGroup": "Output", "name": "check", "summary": "Compare instead of writing, and exit non-zero when the file is stale or missing.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "zero:types", "pluginAlias": "spacefast", "pluginName": "spacefast", "pluginType": "core", "strict": true, "summary": "Generate types from a space's content model, Abilities, and database.", "enableJsonFlag": true, "allowsMissingEnvironmentProfile": false, "isESM": true, "relativePath": [ "dist", "commands", "zero", "types.js" ], "aliasPermutations": [], "permutations": [ "zero:types", "types:zero" ] } }, "version": "0.4.1" }