create-moost
v0.6.31
Published
create-moost
Maintainers
Readme
create-moost
create-moost is an npm initializer that scaffolds new Moost applications. It supports four project types: HTTP (Web) application, Vue + Moost (SSR/SPA), WebSocket application, and CLI application.
Getting Started
Make sure you have Node.js 20.19+ (or 22.12+) installed — the scaffolded projects rely on Vite/Rolldown, which require it. Then run:
npm create moostWithout flags the CLI runs in interactive mode: it prompts for the project name, the Moost adapter (HTTP, Vue + Moost SSR/SPA, WebSocket, or CLI), and the type-specific options below.
You can pass a project name and a type flag to skip the corresponding prompts:
npm create moost my-app -- --httpFlags
| Flag | Effect |
| --------- | ----------------------------------------------------------------- |
| --http | Scaffold an HTTP (Web) application |
| --ssr | Scaffold a Vue + Moost (SSR/SPA) application |
| --ws | Scaffold a WebSocket application (with --http: add WebSockets to the HTTP app) |
| --cli | Scaffold a CLI application |
| --wf | Include the Moost Workflows example (applied to HTTP projects) |
| --oxc | Add OXC lint and formatter (oxlint + oxfmt) |
| --force | Overwrite a non-empty target directory without asking |
Prompts
Depending on the chosen project type, the CLI asks:
- Project name and package name — skipped when a valid name is passed as an argument
- Enable SSR (Server-Side Rendering)? —
ssrprojects only (answering No produces an SPA-only setup); skipped when--ssris passed - Add WebSockets? —
httpprojects only; skipped when--wsis passed - Add Moost Workflows Example? — skipped for
cliandwsprojects, and when--wfis passed - Add OXC lint and formatter (oxlint + oxfmt)? — asked for every project type unless
--oxcis passed
Each flag pre-selects its answer and skips the matching prompt, so passing all relevant flags scaffolds fully non-interactively, e.g. npm create moost my-app -- --http --ws --wf --oxc --force.
After scaffolding, the CLI prints the next steps (install dependencies and start the dev server).
