@spacefast/common 0.0.3 → 0.0.6

package/dist/docs/catalog.d.ts

@@ -0,0 +1,650 @@
+import type { CliDisclosureTier } from "../vocabulary.js";
+/** Which part of the docs a page belongs to (runtime list + derived type). */
+export declare const DOC_KINDS: readonly ["guide", "cli", "api", "recipe", "workflow", "error"];
+/** Which part of the docs a page belongs to. */
+export type DocKind = (typeof DOC_KINDS)[number];
+/** One searchable documentation page. */
+export interface DocEntry {
+    /** Stable, lowercase topic id used by `sf docs <topic>` (e.g. "publish", "api/spaces"). */
+    readonly slug: string;
+    /** Human title shown in results. */
+    readonly title: string;
+    /** Which docs area this page lives in. */
+    readonly kind: DocKind;
+    /** Disclosure tier that gates the page in `sf docs` listings. */
+    readonly tier: CliDisclosureTier;
+    /** One-line summary printed alongside the title. */
+    readonly summary: string;
+    /** Extra search terms that should match this page. */
+    readonly keywords: readonly string[];
+    /** Canonical docs URL. */
+    readonly url: string;
+    /** Short printable body shown by `sf docs <topic>`. */
+    readonly body: string;
+}
+/** Base URL all bundled docs links resolve against. */
+export declare const DOCS_BASE_URL = "https://spacefast.com/docs";
+/** Base URL for the standalone recipe pages (served at /recipes, not /docs). */
+export declare const RECIPES_BASE_URL = "https://spacefast.com/recipes";
+export declare const DOCS_CATALOG: readonly [{
+    readonly slug: "quickstart";
+    readonly title: "Quickstart";
+    readonly kind: "guide";
+    readonly tier: "essential";
+    readonly summary: "Publish your first space in under two minutes.";
+    readonly keywords: readonly ["start", "getting started", "first", "new", "setup", "hello world"];
+    readonly url: "https://spacefast.com/docs/quickstart";
+    readonly body: "Install the CLI, run `sf init` in your working directory, then `sf publish` to take the current build live on a new space.";
+}, {
+    readonly slug: "publishing";
+    readonly title: "Publishing a space";
+    readonly kind: "guide";
+    readonly tier: "essential";
+    readonly summary: "How `sf publish` builds, uploads, and goes live.";
+    readonly keywords: readonly ["publish", "go live", "upload", "release", "static"];
+    readonly url: "https://spacefast.com/docs/publishing";
+    readonly body: "`sf publish` snapshots your output directory into an immutable version and promotes it to the production channel. Use `--no-wait` to return before serving finishes.";
+}, {
+    readonly slug: "versions-and-rollback";
+    readonly title: "Versions and rollback";
+    readonly kind: "guide";
+    readonly tier: "essential";
+    readonly summary: "Every publish is an immutable version you can roll back to.";
+    readonly keywords: readonly ["version", "rollback", "history", "revert", "channel", "promote"];
+    readonly url: "https://spacefast.com/docs/rollback";
+    readonly body: "List versions with `sf versions`, promote one to a channel, and undo a bad publish instantly with `sf rollback`.";
+}, {
+    readonly slug: "anonymous-publish";
+    readonly title: "Anonymous publish and claim";
+    readonly kind: "guide";
+    readonly tier: "essential";
+    readonly summary: "Publish without an account, then claim the space with its token.";
+    readonly keywords: readonly ["anonymous", "claim", "unclaimed", "agent", "token", "adopt"];
+    readonly url: "https://spacefast.com/docs/anonymous-publish";
+    readonly body: "Publish without logging in to get an instant URL and a claim token; run `sf spaces claim` with that token to bind the space to your account.";
+}, {
+    readonly slug: "agents";
+    readonly title: "Agents and MCP";
+    readonly kind: "guide";
+    readonly tier: "essential";
+    readonly summary: "Let an AI agent publish and operate spaces via the CLI, API, or MCP.";
+    readonly keywords: readonly ["agent", "ai", "mcp", "model context protocol", "automation", "assistant"];
+    readonly url: "https://spacefast.com/docs/agents";
+    readonly body: "Agents use the same REST API and CLI as humans. Install the MCP server with `sf mcp install` so an assistant can publish, inspect, and manage spaces with structured tools.";
+}, {
+    readonly slug: "workflow/publish-curl";
+    readonly title: "No-install publish with curl";
+    readonly kind: "workflow";
+    readonly tier: "full";
+    readonly summary: "Publish a file or zipped output folder directly to /v1/publish. No account, CLI install, or MCP setup is required for anonymous publishes.";
+    readonly keywords: readonly ["publish", "curl", "anonymous", "no install", "claim"];
+    readonly url: "https://spacefast.com/docs/agents#publish-with-curl";
+    readonly body: "curl publish static file folder archive zip anonymous no account no install live URL immutable version claim link /v1/publish";
+}, {
+    readonly slug: "workflow/publish-receipt";
+    readonly title: "Publish receipt fields";
+    readonly kind: "workflow";
+    readonly tier: "full";
+    readonly summary: "Use the receipt as the source of truth: space.liveUrl, version.immutableUrl, shareBlurb, claim.url, claim.expiresAt, links, diagnostics, and errors.";
+    readonly keywords: readonly ["receipt", "share", "claim", "diagnostics"];
+    readonly url: "https://spacefast.com/docs/api#publish";
+    readonly body: "receipt liveUrl immutableUrl shareBlurb claim url expiresAt diagnostics links finalize promote upload errors docsUrl";
+}, {
+    readonly slug: "workflow/continue-after-claim";
+    readonly title: "Keep publishing after the user claims";
+    readonly kind: "workflow";
+    readonly tier: "full";
+    readonly summary: "After the owner claims an anonymous space with continuation enabled, exchange the saved claim token once for a durable space-scoped access token, save it over the claim token, and keep publishing.";
+    readonly keywords: readonly ["continue", "exchange", "claim token", "space_claimed_credential_available", "continuation"];
+    readonly url: "https://spacefast.com/docs/agents#continue-after-claim";
+    readonly body: "continue continuation claim token exchange voucher continue_space POST /v1/anonymous-claim/exchange space_claimed_credential_available continuation_used continuation_unavailable durable access token state.json update after claim claim_status";
+}, {
+    readonly slug: "workflow/secret-handling";
+    readonly title: "Secret handling rules";
+    readonly kind: "workflow";
+    readonly tier: "full";
+    readonly summary: "Treat claim tokens, upload tokens, device codes, API keys, auth files, and .spacefast state as credentials. Do not print, commit, archive, or log them.";
+    readonly keywords: readonly ["secret", "token", "claim token", "redact"];
+    readonly url: "https://spacefast.com/docs/agents#secret-handling";
+    readonly body: "secret handling claim token upload token device code API key auth file .spacefast state redact logs transcripts archive";
+}, {
+    readonly slug: "workflow/cli-surface";
+    readonly title: "CLI command surface";
+    readonly kind: "workflow";
+    readonly tier: "full";
+    readonly summary: "Use sf for repeat work: publish, versions, rollback, logs, domains, passwords, teams, API calls, and On-Device MCP serving.";
+    readonly keywords: readonly ["sf", "cli", "spacefast", "mcp", "json"];
+    readonly url: "https://spacefast.com/docs/cli";
+    readonly body: "sf spacefast CLI publish versions rollback logs domains passwords teams api mcp setup profile login --json";
+}, {
+    readonly slug: "workflow/mcp-local";
+    readonly title: "On-Device MCP through the CLI";
+    readonly kind: "workflow";
+    readonly tier: "full";
+    readonly summary: "Run sf mcp for stdio or sf mcp http --host 127.0.0.1 --port 3945 --path /mcp for On-Device Streamable HTTP.";
+    readonly keywords: readonly ["mcp", "stdio", "streamable http", "on-device", "local"];
+    readonly url: "https://spacefast.com/docs/agents#mcp";
+    readonly body: "MCP on-device local CLI stdio streamable HTTP sf mcp roots files workspace tool calls structuredContent apps";
+}, {
+    readonly slug: "workflow/workspace-files";
+    readonly title: "Agent workspace files";
+    readonly kind: "workflow";
+    readonly tier: "full";
+    readonly summary: "Hosted MCP workspace tools edit, import, export, and publish a durable virtual workspace; On-Device MCP workspace tools edit the bounded local root.";
+    readonly keywords: readonly ["workspace", "files", "patch", "diff", "virtual workspace", "workspace import", "workspace export", "just-bash"];
+    readonly url: "https://spacefast.com/docs/agents#workspace-files";
+    readonly body: "workspace file editing read write patch diff list manifest import export import_url hosted virtual workspace just-bash shell handoff on-device root SPACEFAST_MCP_WORKSPACE_ROOT secret scanning bounded files";
+}, {
+    readonly slug: "workflow/mcp-resources";
+    readonly title: "MCP resources for account, teams, spaces, and policy";
+    readonly kind: "workflow";
+    readonly tier: "full";
+    readonly summary: "Use read-only resources for bounded context before tools: account/current, teams/current, spaces/recent, space detail, recent versions, policy/current, and workspace/manifest.";
+    readonly keywords: readonly ["resources", "account", "teams", "spaces", "policy", "context"];
+    readonly url: "https://spacefast.com/docs/agents#mcp-resources";
+    readonly body: "MCP resources account current teams current list spaces recent space detail versions recent domains logs summary policy current workspace manifest tools catalog read-only context redacted";
+}, {
+    readonly slug: "workflow/space-files";
+    readonly title: "Space file conventions";
+    readonly kind: "workflow";
+    readonly tier: "full";
+    readonly summary: "Spacefast recognizes _redirects, _headers, nearest 404.html, and sf.jsonc. Static artifacts are served as files; server code is not executed.";
+    readonly keywords: readonly ["_redirects", "_headers", "sf.jsonc", "spacefast.jsonc", "404"];
+    readonly url: "https://spacefast.com/docs/configuration";
+    readonly body: "_redirects _headers 404.html sf.jsonc static artifact server code not executed proxy rewrite headers basic auth";
+}, {
+    readonly slug: "workflow/domains-diagnostics";
+    readonly title: "Domains and DNS diagnostics";
+    readonly kind: "workflow";
+    readonly tier: "full";
+    readonly summary: "Use domain diagnostics for attach, verification, DNS, nameserver, and rollback-safe recovery steps.";
+    readonly keywords: readonly ["domain", "dns", "verification"];
+    readonly url: "https://spacefast.com/docs/domains";
+    readonly body: "domains DNS diagnostics attach verification nameservers custom domain certificate recovery instructions";
+}, {
+    readonly slug: "workflow/logs-diagnostics";
+    readonly title: "Logs and diagnostics";
+    readonly kind: "workflow";
+    readonly tier: "full";
+    readonly summary: "Use access logs for traffic questions, runtime logs for serving diagnostics, and build logs for publish/finalize failures.";
+    readonly keywords: readonly ["logs", "diagnostics", "build logs"];
+    readonly url: "https://spacefast.com/docs/builds#watch-and-manage-builds";
+    readonly body: "logs access runtime build diagnostics publish finalize failures request id docsUrl suggestions recovery";
+}, {
+    readonly slug: "workflow/agent-auth";
+    readonly title: "Agent accounts and OAuth";
+    readonly kind: "workflow";
+    readonly tier: "full";
+    readonly summary: "Prefer OAuth agent accounts with private_key_jwt and SPACEFAST_AGENT_CONFIG for On-Device MCP and automation instead of broad shared API keys.";
+    readonly keywords: readonly ["oauth", "agent account", "private_key_jwt", "SPACEFAST_AGENT_CONFIG"];
+    readonly url: "https://spacefast.com/docs/agents#agent-accounts";
+    readonly body: "OAuth agent account private_key_jwt SPACEFAST_AGENT_CONFIG client credentials scoped token mcp automation teams";
+}, {
+    readonly slug: "custom-domains";
+    readonly title: "Custom domains";
+    readonly kind: "guide";
+    readonly tier: "full";
+    readonly summary: "Attach your own domain and let Spacefast manage TLS.";
+    readonly keywords: readonly ["domain", "dns", "https", "tls", "certificate", "cname", "nameserver"];
+    readonly url: "https://spacefast.com/docs/domains";
+    readonly body: "Add a domain with `sf domains add`, point DNS at Spacefast, and a certificate is issued automatically. Inspect status with `sf domains check`.";
+}, {
+    readonly slug: "configuration";
+    readonly title: "Configuration (sf.jsonc)";
+    readonly kind: "guide";
+    readonly tier: "full";
+    readonly summary: "Ship space metadata and SPA settings alongside your files.";
+    readonly keywords: readonly ["config", "sf.jsonc", "spacefast.jsonc", "metadata", "spa", "schema", "settings"];
+    readonly url: "https://spacefast.com/docs/configuration";
+    readonly body: "Add `sf.jsonc` at your publish root so configuration travels with each version and rolls back with it. `sf init` scaffolds it with a `$schema` pointer for autocomplete.";
+}, {
+    readonly slug: "environment-variables";
+    readonly title: "Environment variables";
+    readonly kind: "guide";
+    readonly tier: "full";
+    readonly summary: "Set build-time configuration and secrets per space.";
+    readonly keywords: readonly ["env", "environment", "secrets", "config", "variables", "dotenv"];
+    readonly url: "https://spacefast.com/docs/configuration";
+    readonly body: "Manage a space's variables with `sf env set` / `sf env ls`, or import a dotenv file with `sf env import`. Secret values are masked in `--json` output.";
+}, {
+    readonly slug: "access-control";
+    readonly title: "Access control";
+    readonly kind: "guide";
+    readonly tier: "full";
+    readonly summary: "Password-protect a space or grant access to specific people.";
+    readonly keywords: readonly ["access", "password", "grant", "ban", "private", "audience", "auth"];
+    readonly url: "https://spacefast.com/docs/access";
+    readonly body: "Gate a space with `sf password set`, grant individuals with `sf access grant`, and review effective rules with `sf access effective`.";
+}, {
+    readonly slug: "redirects";
+    readonly title: "Redirects";
+    readonly kind: "guide";
+    readonly tier: "full";
+    readonly summary: "Declare redirect rules that travel with each version.";
+    readonly keywords: readonly ["redirect", "rewrite", "routing", "301", "302", "_redirects"];
+    readonly url: "https://spacefast.com/docs/redirects";
+    readonly body: "Add a `_redirects` file at your publish root to redirect, rewrite, or proxy; it compiles at finalize and rolls back with the version. Inspect resolution with `sf routing inspect`.";
+}, {
+    readonly slug: "headers";
+    readonly title: "Custom headers";
+    readonly kind: "guide";
+    readonly tier: "full";
+    readonly summary: "Attach response headers and path-scoped Basic Auth.";
+    readonly keywords: readonly ["headers", "cache", "security", "basic auth", "_headers", "cors"];
+    readonly url: "https://spacefast.com/docs/headers";
+    readonly body: "Add a `_headers` file at your publish root to set or remove response headers per path. Path-scoped Basic Auth credentials travel with the publish.";
+}, {
+    readonly slug: "builds";
+    readonly title: "Build from Git";
+    readonly kind: "guide";
+    readonly tier: "full";
+    readonly summary: "Connect a repository so pushes build and publish automatically.";
+    readonly keywords: readonly ["build", "git", "github", "ci", "push", "connect", "preview"];
+    readonly url: "https://spacefast.com/docs/builds";
+    readonly body: "Connect a repository with `sf git connect`; each push runs your build on Spacefast and publishes a version, with branches and pull requests getting preview URLs.";
+}, {
+    readonly slug: "collab";
+    readonly title: "Collaboration and annotations";
+    readonly kind: "guide";
+    readonly tier: "full";
+    readonly summary: "Leave review comments on a published space.";
+    readonly keywords: readonly ["collab", "annotations", "comments", "review", "feedback", "annotate"];
+    readonly url: "https://spacefast.com/docs/collab";
+    readonly body: "Annotate a live space with review comments and resolve them from the CLI with `sf annotations` or in the dashboard.";
+}, {
+    readonly slug: "analytics";
+    readonly title: "Analytics";
+    readonly kind: "guide";
+    readonly tier: "full";
+    readonly summary: "See traffic and visitor counts for a space.";
+    readonly keywords: readonly ["analytics", "traffic", "visitors", "stats", "metrics", "pageviews"];
+    readonly url: "https://spacefast.com/docs/cli";
+    readonly body: "Inspect a space's traffic with `sf analytics`; history depth and granularity depend on the team's plan.";
+}, {
+    readonly slug: "proxy-routes";
+    readonly title: "Proxy routes";
+    readonly kind: "guide";
+    readonly tier: "reference";
+    readonly summary: "Proxy selected paths to an upstream origin.";
+    readonly keywords: readonly ["proxy", "upstream", "route", "api", "backend", "rewrite"];
+    readonly url: "https://spacefast.com/docs/proxy-routes";
+    readonly body: "Forward specific path prefixes to an external upstream so a static space can front a dynamic API without exposing the origin.";
+}, {
+    readonly slug: "image-acceleration";
+    readonly title: "Image acceleration";
+    readonly kind: "guide";
+    readonly tier: "reference";
+    readonly summary: "Serve optimized, resized images from your space.";
+    readonly keywords: readonly ["image", "images", "optimization", "resize", "cdn", "acceleration"];
+    readonly url: "https://spacefast.com/docs/image-acceleration";
+    readonly body: "Spacefast can resize and re-encode images on the fly so you ship one source asset and serve device-appropriate variants.";
+}, {
+    readonly slug: "integrations/nextjs";
+    readonly title: "Next.js integration";
+    readonly kind: "guide";
+    readonly tier: "reference";
+    readonly summary: "Publish a Next.js static export to a space.";
+    readonly keywords: readonly ["nextjs", "next", "react", "framework", "integration", "export"];
+    readonly url: "https://spacefast.com/docs/integrations/nextjs";
+    readonly body: "Build your Next.js static export and publish the output directory with `sf publish`; `sf init` detects the framework and sets the output path.";
+}, {
+    readonly slug: "integrations/vite";
+    readonly title: "Vite integration";
+    readonly kind: "guide";
+    readonly tier: "reference";
+    readonly summary: "Publish a Vite build to a space.";
+    readonly keywords: readonly ["vite", "react", "vue", "svelte", "framework", "integration", "build"];
+    readonly url: "https://spacefast.com/docs/integrations/vite";
+    readonly body: "Run your Vite build and publish `dist/` with `sf publish`; `sf init` detects Vite and preconfigures the output directory.";
+}, {
+    readonly slug: "limits";
+    readonly title: "Limits and quotas";
+    readonly kind: "guide";
+    readonly tier: "reference";
+    readonly summary: "File counts, sizes, and rate limits per plan.";
+    readonly keywords: readonly ["limits", "quota", "size", "rate limit", "plan", "storage"];
+    readonly url: "https://spacefast.com/docs/limits";
+    readonly body: "Reference for per-space file counts, archive and file size ceilings, version retention, and rate limits, which vary by plan.";
+}, {
+    readonly slug: "troubleshooting";
+    readonly title: "Troubleshooting";
+    readonly kind: "guide";
+    readonly tier: "reference";
+    readonly summary: "Diagnose failed publishes, builds, and domains.";
+    readonly keywords: readonly ["troubleshoot", "debug", "error", "doctor", "diagnose", "fix"];
+    readonly url: "https://spacefast.com/docs/troubleshooting";
+    readonly body: "Common publish, build, and domain failures and how to resolve them. Run `sf doctor` to check your local setup and auth state.";
+}, {
+    readonly slug: "migrate-from";
+    readonly title: "Migrate to Spacefast";
+    readonly kind: "guide";
+    readonly tier: "reference";
+    readonly summary: "Move from Netlify, Vercel, and other hosts.";
+    readonly keywords: readonly ["migrate", "netlify", "vercel", "cloudflare", "github pages", "here.now", "import"];
+    readonly url: "https://spacefast.com/docs/migrate-from";
+    readonly body: "Step-by-step migrations that map another host's build output, redirects, and headers onto a Spacefast space.";
+}, {
+    readonly slug: "cli";
+    readonly title: "CLI overview";
+    readonly kind: "cli";
+    readonly tier: "essential";
+    readonly summary: "Install, authenticate, and the first-publish command path.";
+    readonly keywords: readonly ["cli", "sf", "command", "install", "overview", "help"];
+    readonly url: "https://spacefast.com/docs/cli";
+    readonly body: "Run `sf help` for the essential commands, `sf help --full` for everything. The CLI emits a `{ data }` / `{ error }` JSON envelope under `--json`.";
+}, {
+    readonly slug: "cli/publish";
+    readonly title: "sf publish";
+    readonly kind: "cli";
+    readonly tier: "essential";
+    readonly summary: "Build, upload, and take the current output live on a space.";
+    readonly keywords: readonly ["publish", "sf publish", "go live", "upload", "release"];
+    readonly url: "https://spacefast.com/docs/cli";
+    readonly body: "`sf publish [DIR]` snapshots a directory into an immutable version and promotes it to the production channel. Add `--no-wait` to return before serving finishes.";
+}, {
+    readonly slug: "login";
+    readonly title: "sf login";
+    readonly kind: "cli";
+    readonly tier: "essential";
+    readonly summary: "Authenticate the CLI with your Spacefast account.";
+    readonly keywords: readonly ["login", "auth", "authenticate", "token", "device", "signin"];
+    readonly url: "https://spacefast.com/docs/cli";
+    readonly body: "`sf login` starts the device-authorization flow; for non-interactive use pass `--token` or set `SPACEFAST_TOKEN`.";
+}, {
+    readonly slug: "init";
+    readonly title: "sf init";
+    readonly kind: "cli";
+    readonly tier: "essential";
+    readonly summary: "Scaffold an sf.jsonc config in the current directory.";
+    readonly keywords: readonly ["init", "config", "scaffold", "sf.jsonc", "setup"];
+    readonly url: "https://spacefast.com/docs/cli";
+    readonly body: "`sf init` detects your framework and writes a starter `sf.jsonc` so subsequent `sf publish` runs are zero-config.";
+}, {
+    readonly slug: "claim";
+    readonly title: "sf spaces claim";
+    readonly kind: "cli";
+    readonly tier: "essential";
+    readonly summary: "Attach an anonymously-published space to your account.";
+    readonly keywords: readonly ["claim", "anonymous", "attach", "token", "adopt", "spaces"];
+    readonly url: "https://spacefast.com/docs/cli";
+    readonly body: "After an agent publishes anonymously, run `sf spaces claim` with the claim token to bind the space to your account.";
+}, {
+    readonly slug: "cli/spaces";
+    readonly title: "sf spaces";
+    readonly kind: "cli";
+    readonly tier: "full";
+    readonly summary: "List, inspect, transfer, import, and remove spaces.";
+    readonly keywords: readonly ["spaces", "space", "ls", "get", "rm", "transfer", "import", "export"];
+    readonly url: "https://spacefast.com/docs/cli";
+    readonly body: "The `sf spaces` group manages spaces: `ls`, `get`, `claim`, `transfer`, `duplicate`, `import`/`export`, and `rm`.";
+}, {
+    readonly slug: "cli/versions";
+    readonly title: "sf versions";
+    readonly kind: "cli";
+    readonly tier: "full";
+    readonly summary: "List, inspect, download, and remove immutable versions.";
+    readonly keywords: readonly ["versions", "version", "ls", "get", "download", "rollback", "history"];
+    readonly url: "https://spacefast.com/docs/cli";
+    readonly body: "`sf versions ls` shows a space's history; `sf versions get` inspects one and `sf rollback` promotes an earlier version back to live.";
+}, {
+    readonly slug: "cli/channels";
+    readonly title: "sf channels";
+    readonly kind: "cli";
+    readonly tier: "full";
+    readonly summary: "List channels and see which version each points at.";
+    readonly keywords: readonly ["channels", "channel", "promote", "production", "preview", "history"];
+    readonly url: "https://spacefast.com/docs/cli";
+    readonly body: "`sf channels ls` lists a space's channels and their current version; `sf channels history` shows past pointer moves. Move a channel with `sf promote`.";
+}, {
+    readonly slug: "cli/domains";
+    readonly title: "sf domains";
+    readonly kind: "cli";
+    readonly tier: "full";
+    readonly summary: "Add, check, and manage custom domains and DNS.";
+    readonly keywords: readonly ["domains", "domain", "dns", "add", "check", "nameservers", "diagnostics"];
+    readonly url: "https://spacefast.com/docs/cli";
+    readonly body: "The `sf domains` group covers `add`, `check`, `diagnostics`, `ls`, `rm`, and a full `dns` subtree for managing records and nameservers.";
+}, {
+    readonly slug: "cli/env";
+    readonly title: "sf env";
+    readonly kind: "cli";
+    readonly tier: "full";
+    readonly summary: "Set, list, import, and pull a space's variables.";
+    readonly keywords: readonly ["env", "environment", "variables", "secrets", "set", "import", "pull"];
+    readonly url: "https://spacefast.com/docs/cli";
+    readonly body: "`sf env set` / `sf env ls` manage a space's variables; `sf env import` loads a dotenv file and `sf env pull` writes them back out.";
+}, {
+    readonly slug: "cli/builds";
+    readonly title: "sf builds";
+    readonly kind: "cli";
+    readonly tier: "full";
+    readonly summary: "List, inspect, and retry cloud builds.";
+    readonly keywords: readonly ["builds", "build", "ls", "logs", "retry", "cancel", "ci"];
+    readonly url: "https://spacefast.com/docs/cli";
+    readonly body: "`sf builds ls` lists cloud builds; `sf builds logs`, `sf builds retry`, and `sf builds cancel` operate on a single build.";
+}, {
+    readonly slug: "cli/git";
+    readonly title: "sf git";
+    readonly kind: "cli";
+    readonly tier: "full";
+    readonly summary: "Connect a repository for push-to-publish builds.";
+    readonly keywords: readonly ["git", "github", "connect", "repository", "ci", "sync", "disconnect"];
+    readonly url: "https://spacefast.com/docs/cli";
+    readonly body: "`sf git connect` links a repository so pushes build and publish automatically; `sf git ls`, `sf git sync`, and `sf git disconnect` manage the connection.";
+}, {
+    readonly slug: "cli/access";
+    readonly title: "sf access";
+    readonly kind: "cli";
+    readonly tier: "full";
+    readonly summary: "Grant, ban, and inspect who can view a space.";
+    readonly keywords: readonly ["access", "grant", "ban", "password", "effective", "rules", "policy"];
+    readonly url: "https://spacefast.com/docs/cli";
+    readonly body: "`sf access grant` / `sf access ban` edit access rules; `sf access effective` shows the resolved policy. Use `sf password set` for a shared password.";
+}, {
+    readonly slug: "cli/teams";
+    readonly title: "sf teams";
+    readonly kind: "cli";
+    readonly tier: "full";
+    readonly summary: "Create teams, invite members, and switch context.";
+    readonly keywords: readonly ["teams", "team", "members", "invitations", "switch", "create"];
+    readonly url: "https://spacefast.com/docs/cli";
+    readonly body: "`sf teams create` makes a team, `sf teams invitations add` invites people, `sf teams members ls` lists them, and `sf teams switch` sets the active team.";
+}, {
+    readonly slug: "cli/api-keys";
+    readonly title: "sf api-keys";
+    readonly kind: "cli";
+    readonly tier: "full";
+    readonly summary: "Create and revoke API keys for the platform API.";
+    readonly keywords: readonly ["api-keys", "api key", "token", "create", "revoke", "list", "credential"];
+    readonly url: "https://spacefast.com/docs/cli";
+    readonly body: "`sf api-keys create` mints a bearer key (shown once, masked in `--json`); `sf api-keys list` and `sf api-keys revoke` manage existing keys.";
+}, {
+    readonly slug: "cli/analytics";
+    readonly title: "sf analytics";
+    readonly kind: "cli";
+    readonly tier: "full";
+    readonly summary: "Print traffic and visitor counts for a space.";
+    readonly keywords: readonly ["analytics", "traffic", "visitors", "stats", "metrics"];
+    readonly url: "https://spacefast.com/docs/cli";
+    readonly body: "`sf analytics` reports a space's traffic; history depth and granularity depend on the team's plan.";
+}, {
+    readonly slug: "cli/api";
+    readonly title: "sf api";
+    readonly kind: "cli";
+    readonly tier: "full";
+    readonly summary: "Make an authenticated raw call to the platform API.";
+    readonly keywords: readonly ["api", "sf api", "http", "raw", "request", "curl", "endpoint"];
+    readonly url: "https://spacefast.com/docs/cli";
+    readonly body: "`sf api <METHOD> <PATH>` sends an authenticated request against the platform API and prints the `{ data }` / `{ error }` envelope — handy for endpoints without a dedicated command.";
+}, {
+    readonly slug: "cli/mcp";
+    readonly title: "sf mcp";
+    readonly kind: "cli";
+    readonly tier: "full";
+    readonly summary: "Run and install the Spacefast MCP server.";
+    readonly keywords: readonly ["mcp", "model context protocol", "agent", "install", "server", "tools"];
+    readonly url: "https://spacefast.com/docs/cli";
+    readonly body: "`sf mcp` runs the MCP server so an AI assistant can call Spacefast tools; `sf mcp install` wires it into a supported client's config.";
+}, {
+    readonly slug: "cli/docs";
+    readonly title: "sf docs";
+    readonly kind: "cli";
+    readonly tier: "full";
+    readonly summary: "Search the offline documentation index from the CLI.";
+    readonly keywords: readonly ["docs", "search", "help", "reference", "offline", "topic"];
+    readonly url: "https://spacefast.com/docs/cli";
+    readonly body: "`sf docs` lists documentation topics and `sf docs <topic>` prints a page. The index ships with the CLI and mirrors the machine-readable `GET /v1/docs` API.";
+}, {
+    readonly slug: "json-output";
+    readonly title: "JSON output and exit codes";
+    readonly kind: "cli";
+    readonly tier: "full";
+    readonly summary: "Machine-readable envelopes and stable exit codes for scripts.";
+    readonly keywords: readonly ["json", "exit code", "scripting", "envelope", "automation", "ci", "agent"];
+    readonly url: "https://spacefast.com/docs/cli";
+    readonly body: "Pass `--json` for a `{ data }` success or `{ error }` failure envelope on stdout/stderr. Exit codes are stable so scripts and agents can branch on them.";
+}, {
+    readonly slug: "api";
+    readonly title: "Platform API overview";
+    readonly kind: "api";
+    readonly tier: "full";
+    readonly summary: "Authenticate and call the Spacefast platform API.";
+    readonly keywords: readonly ["api", "rest", "http", "platform", "endpoint", "openapi", "bearer"];
+    readonly url: "https://spacefast.com/docs/api";
+    readonly body: "The platform API uses bearer API keys and returns the same `{ data }` / `{ error }` envelope as the CLI. Create a key with `sf api-keys create`.";
+}, {
+    readonly slug: "api/publish";
+    readonly title: "Publish API";
+    readonly kind: "api";
+    readonly tier: "full";
+    readonly summary: "Publish a version in a single authenticated request.";
+    readonly keywords: readonly ["api", "publish", "upload", "version", "archive", "http"];
+    readonly url: "https://spacefast.com/docs/api";
+    readonly body: "Send your files in one authenticated publish request to create an immutable version and take it live; the response carries the space and live URL.";
+}, {
+    readonly slug: "api/spaces";
+    readonly title: "Spaces API";
+    readonly kind: "api";
+    readonly tier: "full";
+    readonly summary: "Create, list, and update spaces over HTTP.";
+    readonly keywords: readonly ["api", "spaces", "space", "create", "list", "endpoint"];
+    readonly url: "https://spacefast.com/docs/api";
+    readonly body: "`GET /v1/spaces` lists spaces; `POST /v1/spaces` creates one. Responses carry the space id, slug, and live URL.";
+}, {
+    readonly slug: "api/versions";
+    readonly title: "Versions API";
+    readonly kind: "api";
+    readonly tier: "full";
+    readonly summary: "List versions and promote them to channels over HTTP.";
+    readonly keywords: readonly ["api", "versions", "publish", "channel", "promote", "rollback"];
+    readonly url: "https://spacefast.com/docs/api";
+    readonly body: "List a space's versions, then promote one to a channel to move traffic. Rolling back is promoting an earlier version.";
+}, {
+    readonly slug: "api/domains";
+    readonly title: "Domains API";
+    readonly kind: "api";
+    readonly tier: "reference";
+    readonly summary: "Attach and inspect custom domains over HTTP.";
+    readonly keywords: readonly ["api", "domains", "domain", "dns", "certificate", "endpoint"];
+    readonly url: "https://spacefast.com/docs/api";
+    readonly body: "Add a custom domain, read its verification and certificate status, and manage DNS records through the platform API.";
+}, {
+    readonly slug: "api/teams";
+    readonly title: "Teams API";
+    readonly kind: "api";
+    readonly tier: "reference";
+    readonly summary: "Manage teams, members, and invitations over HTTP.";
+    readonly keywords: readonly ["api", "teams", "team", "members", "invitations", "endpoint"];
+    readonly url: "https://spacefast.com/docs/api";
+    readonly body: "Create teams, list members, and manage invitations programmatically. Webhooks and API keys are team-scoped.";
+}, {
+    readonly slug: "api/docs";
+    readonly title: "Docs API (GET /v1/docs)";
+    readonly kind: "api";
+    readonly tier: "reference";
+    readonly summary: "Fetch the machine-readable documentation index.";
+    readonly keywords: readonly ["api", "docs", "index", "discovery", "machine-readable", "v1/docs"];
+    readonly url: "https://spacefast.com/docs/api";
+    readonly body: "`GET /v1/docs` returns the tier-aware docs index (filter with `q` and `category`); `GET /v1/docs/{slug}` returns one page. It mirrors the CLI's offline `sf docs`.";
+}, {
+    readonly slug: "api/webhooks";
+    readonly title: "Webhooks";
+    readonly kind: "api";
+    readonly tier: "reference";
+    readonly summary: "Subscribe to version, build, and domain lifecycle events.";
+    readonly keywords: readonly ["api", "webhook", "events", "callback", "notifications", "build", "signature"];
+    readonly url: "https://spacefast.com/docs/webhooks";
+    readonly body: "Register a team-scoped, signed webhook to receive version, build, domain, and transfer events. Verify the signature header before trusting a payload.";
+}, {
+    readonly slug: "api/platform";
+    readonly title: "Platform (tenant) API";
+    readonly kind: "api";
+    readonly tier: "reference";
+    readonly summary: "The tenant-facing platform API for running Spacefast as infra.";
+    readonly keywords: readonly ["api", "platform", "tenant", "infra", "openapi", "multi-tenant"];
+    readonly url: "https://spacefast.com/docs/platforms";
+    readonly body: "The platform API is the tenant-facing surface for operating Spacefast as hosting infra. It shares the `{ data }` / `{ error }` envelope and is documented via OpenAPI.";
+}, {
+    readonly slug: "recipes/github-deploys";
+    readonly title: "Publish from GitHub";
+    readonly kind: "recipe";
+    readonly tier: "full";
+    readonly summary: "Connect a repository so pushes publish automatically.";
+    readonly keywords: readonly ["github", "git", "ci", "push", "connect", "automatic", "recipe"];
+    readonly url: "https://spacefast.com/docs/builds";
+    readonly body: "Connect a repository with `sf git connect`; each push builds on Spacefast and publishes a version, with pull requests getting preview URLs.";
+}, {
+    readonly slug: "recipes/preview-channels";
+    readonly title: "Preview channels for pull requests";
+    readonly kind: "recipe";
+    readonly tier: "full";
+    readonly summary: "Give every branch a shareable preview URL.";
+    readonly keywords: readonly ["preview", "channel", "branch", "pull request", "staging", "recipe"];
+    readonly url: "https://spacefast.com/docs/builds";
+    readonly body: "Push a branch or open a pull request on a connected repository, or publish to a named channel, to get an isolated preview URL without touching production.";
+}, {
+    readonly slug: "recipes/agent-publish";
+    readonly title: "Let an agent publish for you";
+    readonly kind: "recipe";
+    readonly tier: "full";
+    readonly summary: "Drive a first publish from an AI agent, then claim it.";
+    readonly keywords: readonly ["agent", "ai", "mcp", "anonymous", "claim", "automation", "recipe"];
+    readonly url: "https://spacefast.com/docs/anonymous-publish";
+    readonly body: "Let an agent publish anonymously for an instant URL and a claim token, then hand the token to a human who runs `sf spaces claim`.";
+}, {
+    readonly slug: "recipes/custom-domain";
+    readonly title: "Add a custom domain";
+    readonly kind: "recipe";
+    readonly tier: "full";
+    readonly summary: "Point your own domain at a space with automatic TLS.";
+    readonly keywords: readonly ["domain", "custom domain", "dns", "tls", "https", "recipe"];
+    readonly url: "https://spacefast.com/recipes/custom-domain";
+    readonly body: "Add the domain with `sf domains add`, set the DNS records Spacefast prints, and wait for `sf domains check` to report a ready certificate.";
+}, {
+    readonly slug: "recipes/password-protect";
+    readonly title: "Password-protect a space";
+    readonly kind: "recipe";
+    readonly tier: "full";
+    readonly summary: "Put one shared password in front of a whole space.";
+    readonly keywords: readonly ["password", "protect", "private", "access", "gate", "recipe"];
+    readonly url: "https://spacefast.com/recipes/password-protect-a-space";
+    readonly body: "Run `sf password set` to gate a space behind a single shared secret; clear it later with `sf password clear`.";
+}, {
+    readonly slug: "recipes/redirects";
+    readonly title: "Set up redirects";
+    readonly kind: "recipe";
+    readonly tier: "reference";
+    readonly summary: "Add redirect rules that ship and roll back with a version.";
+    readonly keywords: readonly ["redirect", "rewrite", "routing", "301", "recipe"];
+    readonly url: "https://spacefast.com/recipes/redirects";
+    readonly body: "Add redirect rules to a `_redirects` file at your publish root so they publish as part of the version and roll back with it.";
+}, {
+    readonly slug: "recipes/migrate-dns";
+    readonly title: "Migrate DNS to a custom domain";
+    readonly kind: "recipe";
+    readonly tier: "reference";
+    readonly summary: "Cut traffic over to a Spacefast-served domain safely.";
+    readonly keywords: readonly ["dns", "migrate", "cutover", "domain", "nameserver", "recipe"];
+    readonly url: "https://spacefast.com/recipes/custom-domain";
+    readonly body: "Pre-stage the domain with `sf domains add`, verify the certificate is ready with `sf domains check`, then update DNS to flip traffic with zero downtime.";
+}, ...DocEntry[]];