CLI

What it is

svocs is the companion CLI for sites scaffolded with create-svocs-docs. The scaffolder gets you a working site; svocs keeps it working after day one. It has three commands: doctor checks a site’s configuration, update pulls template fixes into it, and migrate converts a fumadocs site into a new svocs one.

It needs no install step. Run it from your site’s directory:

npx svocs-cli doctor

bunx svocs-cli and pnpm dlx svocs-cli work the same way, and installing the package globally gives you the shorter svocs command. Both commands also accept a path (svocs doctor ../my-docs) if you’d rather not cd.

svocs doctor

Checks for the problems that actually reach our issue tracker:

• SITE_URL still empty in src/lib/site.ts — social cards stay off, sitemap.xml ships empty, and llms.txt links stay relative until it’s set.
• robots.txt missing its Sitemap: line even though SITE_URL is set.
• Missing card fonts under static/fonts/, which fail the build’s OG generation step.
• A server-backed search backend (Typesense, Chroma) configured without the env vars it needs, which fails bun run build.
• A newer template version available on npm.

┌  svocs doctor
│
◆  Scaffolded from create-svocs-docs 0.18.0 (.svocs.json present).
◆  SITE_URL is set (https://docs.example.com).
◆  OG card fonts present.
◆  Search backend "orama" needs no server config.
◆  Template is up to date.
│
└  All checks passed.

The exit code is non-zero when an error-level problem is found, so npx svocs-cli doctor works as a CI step.

svocs update

Scaffolded sites are snapshots: a bug fixed in the template after you scaffold never reaches your site. update closes that gap without touching your work.

It relies on the .svocs.json manifest that create-svocs-docs 0.18+ writes at scaffold time — the template version, the options you picked, and a hash of every file as it was generated. update fetches the latest template, rebuilds what an untouched scaffold with your options would look like, and compares file by file:

┌  svocs update
│
◇  Fetched create-svocs-docs 0.19.0
│
●  update  scripts/og/generate.mjs
▲  skip    content/introduction.md (you modified it)
│
◆  Apply 1 file(s) from template 0.19.0? Yes
│
└  Template 0.18.0 → 0.19.0: 1 updated, 1 skipped (modified by you).

The rules:

• Files you never modified that the template changed are updated.
• Files you modified are skipped and listed, so template changes to them become a manual review instead of a silent overwrite.
• Files new in the template are added.
• Files the template dropped are reported but never deleted — your code may still import them.

package.json follows the same rules, which in practice means it’s skipped once you’ve added a dependency. When that happens update says so; compare its dependencies against the new template if a build breaks after updating.

Since your content lives in content/ and is either starter pages you’ve rewritten or your own files, it’s protected by the same hash check as everything else. update has no special cases.

svocs migrate

Converts an existing fumadocs site into a new svocs site:

npx svocs-cli migrate ../my-fumadocs-site ../my-svocs-site

It scaffolds a fresh site, then converts every page under the source’s content/docs/:

• Frontmatter (title, description) carries over; meta.json ordering becomes _meta.json.
• <Tabs>/<Tab>, <Callout>, <Cards>/<Card> map straight to the svocs components — same items prop, positional tabs, error → danger. Fumadocs [step] heading markers become <Steps> blocks.
• MDX indentation, JSX comments, and relative links are normalized to what mdsvex and static routes expect. Pages that use components come out as .svx, plain ones as .md.
• Site-specific code the converter can’t map (custom components, dynamic JSX) is commented out in place with a svocs migrate TODO marker, so nothing breaks the build and porting is copy-paste work.

Dead internal links carried over from the source are reported at the end, and the new site is configured to warn on them instead of failing prerender; tighten that back up in vite.config.ts once they’re fixed.

Flags: --site-name, --site-url, --repo-url, --accent, and --search mirror the scaffolder’s prompts.

Only fumadocs sources are supported right now. If you’re migrating from something else, open an issue — the converter is built to grow one source at a time.

Sites scaffolded before 0.18

Older scaffolds have no .svocs.json, so update can’t tell your edits from template files and refuses to guess. doctor still works. To adopt updates on an older site, compare it against a fresh scaffold once by hand, then keep the fresh scaffold’s manifest.