CLI

svedocs-cli ships the two project binaries: create-svedocs and svedocs. The unscoped create-svedocs package is a compatibility shim for package-manager create commands and delegates to svedocs-cli.

Create#

Shell
1pnpm create svedocs my-docs --template docs
2npm create svedocs@latest my-docs -- --template docs
3pnpm dlx --package svedocs-cli create-svedocs my-docs --template docs
4svedocs create my-docs --template cloudflare

The create command detects the invoking package manager from npm_config_user_agent, then the current project, then falls back to pnpm, npm, yarn, and bun. Use --package-manager or --pm to override it. By default it scaffolds without installing dependencies; add --install to run the selected package manager immediately.

Templates:

Template	Purpose
minimal	Small SvelteKit docs project with local rendering.
docs	Documentation site with local MiniSearch-powered search, sitemap, robots, and OG routes.
cloudflare	Edge-first project with Cloudflare Pages config and AI Search binding shape.

Build#

Shell
1svedocs build --mode edge
2svedocs build --mode static
3svedocs ssg
4svedocs build --mode spa

edge is the default and targets Cloudflare Pages SSR. static and svedocs ssg prerender the docs site. spa prerenders known pages and writes a static fallback for constrained hosts; hosted Search, Ask AI, and other server-only features fall back to local behavior unless an edge runtime is available.

Check#

Shell
1svedocs check --strict
2svedocs check --translations
3svedocs check --package
4svedocs check --config ./svedocs.config.ts

Checks include duplicate routes, duplicate canonical URLs, missing descriptions, broken internal links, broken anchors, local assets, empty search output, SPA risk, optional translation gap warnings, and optional package export validation.

Index#

Shell
1svedocs index --format json --out static/search.json
2svedocs index --format jsonl --out static/search.jsonl
3svedocs index --provider cloudflare-ai-search --dry-run

Cloudflare AI Search indexing supports append and replace strategies:

Shell
1svedocs index \
2  --provider cloudflare-ai-search \
3  --strategy replace \
4  --existing old-id,stale-id \
5  --delete manual-delete \
6  --wait

Set CLOUDFLARE_ACCOUNT_ID and CLOUDFLARE_API_TOKEN to upload records. Without credentials, the command stays in dry-run mode.

OG#

Shell
1svedocs og --format svg --out static/og
2svedocs og --format png --out static/og
3svedocs og --renderer satori --font ./Inter-Regular.ttf --format png

SVG output has no native runtime dependency. PNG output uses Resvg at generation time.

Deploy#

Shell
1svedocs deploy cloudflare
2svedocs deploy cloudflare --write

The dry-run prints the generated wrangler.toml and platform type declarations. --write creates wrangler.toml and src/app.cloudflare.d.ts. Pass --format jsonc when you need wrangler.jsonc.