create-zship
create-zship is the official scaffolding CLI. It generates a standalone Nuxt tenant frontend — a trimmed monorepo (apps/web plus its workspace package closure) that connects to an existing, shared multi-tenant ZShip backend. Data stays isolated by app_key.
pnpm create zship@latest and npx create-zship@latest will only work after the package is released. The commands below are the planned post-publish entry points — see Use from the monorepo for what works today.Usage (after npm publish)
pnpm create zship@latest my-saas
# or
npx create-zship@latest my-saas
The interactive prompts ask for the app key, site name, and domain, then generate the project, run pnpm install, and optionally git init.
Use from the monorepo (today)
Until the package is published, run the CLI directly from a ZShip monorepo checkout:
node packages/create-zship/bin/create-zship.js my-saas --yes --skip-install --skip-git
What you get
| Included | Not included |
|---|---|
Nuxt app (apps/web) + workspace package closure | Backend Workers |
Parameterized appKey / brand / wrangler name | Admin tenant registration |
.env.example, doctor, README | Cloudflare resource provisioning |
pnpm install + optional git init | Deploy |
The backend mode is fixed to existing: your new frontend talks to the shared multi-tenant ZShip services, and all data is scoped by app_key.
Flags
create-zship my-saas \
--template nuxt \
--app-key my-saas \
--site-name "My SaaS" \
--domain my-saas.example \
--backend existing \
--port 4323 \
--skip-install \
--skip-git
--yes— accept defaults, skip prompts--skip-install/--skip-git— skippnpm install/git init--source-root <path>— copy from a local ZShip monorepo--template-dir <path>— copy from a packed template directory
Next steps
Scaffolding only creates the frontend. To go live you still need to:
- Register the project (
app_key) in the Admin Console - Configure environment variables from
.env.example - Deploy the frontend to Cloudflare — see Frontend Apps
For the full tenant onboarding flow, read the repository guide docs/NEW_PROJECT_GUIDE.md; for CLI internals and the publish checklist, see packages/create-zship/README.md.