CLI

npx svelte-realtime [project-name] [--template <template>]

Interactive mode

Run without arguments to get prompted:

npx svelte-realtime

You’ll be asked for a project name and template via @clack/prompts.

Non-interactive mode

npx svelte-realtime my-app
npx svelte-realtime my-app --template minimal
npx svelte-realtime my-app --template demo

Templates

TemplateDescription
example (default)Working counter - adapter, plugins, hooks, src/live/counter.ts, and a page that uses it
minimalJust the wiring - adapter, plugins, hooks, empty src/live/ directory
demoClones the full svelte-realtime-demo collaborative sticky notes app

Package manager detection

The CLI detects your package manager automatically:

You runIt uses
npx svelte-realtimenpm
pnpm dlx svelte-realtimepnpm
yarn dlx svelte-realtimeyarn
bunx svelte-realtimebun

Was this page helpful?