create-zship
一条命令脚手架出一个独立的 Nuxt 租户前端,接入现有 ZShip 后端。
create-zship 是官方脚手架 CLI。它生成一个独立的 Nuxt 租户前端——裁剪后的 monorepo(apps/web 及其 workspace 依赖包闭包),接入现有的多租户共享 ZShip 后端,数据按 app_key 隔离。
尚未发布到 npm。
pnpm create zship@latest 与 npx create-zship@latest 要等包发布后才会可用。下面的命令是发布后的入口,当前可用方式见从 monorepo 使用。用法(npm 发布后)
pnpm create zship@latest my-saas
# 或
npx create-zship@latest my-saas
交互式提问会询问 app key、站点名称和域名,然后生成项目、执行 pnpm install,并可选 git init。
从 monorepo 使用(当前方式)
在包发布之前,可在 ZShip monorepo 检出中直接运行 CLI:
node packages/create-zship/bin/create-zship.js my-saas --yes --skip-install --skip-git
生成内容
| 包含 | 不包含 |
|---|---|
Nuxt 应用(apps/web)+ workspace 依赖包闭包 | 后端 Workers |
参数化的 appKey / 品牌 / wrangler 名称 | Admin 租户注册 |
.env.example、doctor、README | Cloudflare 资源开通 |
pnpm install + 可选 git init | 部署 |
后端模式固定为 existing:新前端接入共享的多租户 ZShip 服务,所有数据按 app_key 隔离。
参数
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— 接受默认值,跳过交互提问--skip-install/--skip-git— 跳过pnpm install/git init--source-root <path>— 从本地 ZShip monorepo 拷贝--template-dir <path>— 从打包好的模板目录拷贝
后续步骤
脚手架只生成前端。要上线还需要:
- 在 Admin Console 注册项目(
app_key) - 按
.env.example配置环境变量 - 部署前端到 Cloudflare——见前端应用
完整的租户开通流程见仓库指南 docs/NEW_PROJECT_GUIDE.md;CLI 内部结构与发布清单见 packages/create-zship/README.md。
