create-sailor 1.10.1 → 2.0.0

package/README.md

@@ -1,6 +1,6 @@
 # create-sailor
 
-> Governed scaffolding for AI-native SaaS. Bootstrap the Nebutra Sailor platform baseline with multi-tenant foundations, region-aware defaults, and production-ready AI integrations.
+> Governed scaffolding for AI-native SaaS. One converged stack, zero questions: Next.js + Hono + Postgres + Better Auth + Stripe, with every capability live the moment you add its key.
 
 [![npm version](https://img.shields.io/npm/v/create-sailor.svg?color=0033FE)](https://www.npmjs.com/package/create-sailor)
 [![License: MIT](https://img.shields.io/badge/License-MIT-0033FE.svg)](https://opensource.org/licenses/MIT)
@@ -24,152 +24,52 @@ bunx create-sailor@latest
 
 ## What You Get
 
-- **Governed platform baseline** — web app, marketing site, API gateway, docs, Storybook, studio, and supporting infra packages scaffolded as one coherent monorepo
-- **Verified scaffolding path** — region-aware defaults, template checks, and reproducible project bootstrap instead of hand-assembling a starter stack
-- **AI runtime foundation** — provider registry, Vercel AI SDK v5, OpenAI-compatible endpoints, and agent-ready packages wired into the platform baseline
-- **Global + China delivery surface** — email, storage, monitoring, analytics, SMS, payments, and CN social login options selected through one scaffolding flow
-- **Brand, tenant, and compliance primitives** — white-label branding, multi-tenant foundations, and China-market compliance scaffolding already wired in
+One stack, no questions. Every project is the same converged baseline that
+Nebutra runs in production:
+
+| Capability | Provider |
+|---|---|
+| App + API | Next.js + Hono gateway (mounted in Next, or deployed on its own) |
+| Database | Postgres + Prisma |
+| Auth | Better Auth |
+| Payments | Stripe, plus WeChat Pay / Alipay for mainland China |
+| Email | Resend |
+| SMS | Twilio Verify, plus Aliyun for mainland China |
+| Object storage | any S3-compatible bucket (Cloudflare R2, Aliyun OSS) |
+| Queue / cache | QStash / Redis |
+| Search | Postgres (pgvector) |
+| Monitoring / analytics / captcha | Sentry / PostHog / Turnstile |
+
+Nothing is pruned and nothing is picked at scaffold time. Every capability runs
+locally with an empty `.env`; adding a provider key takes it live.
+`nebutra status` shows what is live and what each capability still needs.
+
+Mainland-China deployments set `NEBUTRA_LOCALE=cn` at runtime (ICP footer, AIGC
+disclosure, phone-first login) — the same code, not a different scaffold.
 
 ## Usage
 
-### Interactive (recommended)
-
 ```bash
-npx create-sailor@latest
+npx create-sailor@latest my-app          # the only question is where
+npx create-sailor@latest .               # into the current directory
+npx create-sailor@latest my-app --json   # NDJSON events, for agents and CI
 ```
 
-Interactive flow:
-
-1. **Where** — new folder (name, default `my-app`) or current directory (smart default if cwd is empty)
-2. **Region / Auth / AI topology**
-3. **Plan** — compact summary; confirm or customize payment · email · storage · deploy
-4. **Done** — short golden path (`cd` → env → migrate → dev)
-
-Everything else uses region-aware smart defaults (`--yes` skips prompts).
-
-```bash
-npx create-sailor@latest my-app   # new folder
-npx create-sailor@latest .        # current directory
-```
-
-The AI prompt is topology-first:
-
-- `gateway` — Multi-provider AI Gateway / router, the recommended default. The scaffold seeds a small provider registry for local development, but runtime provider enablement stays a governance/routing concern.
-- `direct` — Direct SDK/provider adapters for teams that intentionally want concrete providers wired at create time.
-- `custom` — OpenAI-compatible endpoint for proxy, local, or enterprise gateway deployments.
-- `none` — Skip AI scaffolding.
-
-### Non-interactive (expert mode)
-
-```bash
-npm create sailor@latest my-app \
-  --region=cn \
-  --auth=clerk \
-  --social-login=wechat,dingtalk,feishu \
-  --ai=deepseek,qwen,siliconflow \
-  --email=aliyun-dm \
-  --storage=aliyun-oss \
-  --monitoring=sentry \
-  --analytics=baidu \
-  --sms=aliyun-sms \
-  --payment=wechat \
-  --deploy=selfhost \
-  -y
-```
-
-## CLI Flags
-
-| Flag | Values | Default |
-|------|--------|---------|
-| `--region` | `global` · `cn` · `hybrid` | `global` |
-| `--auth` | `clerk` · `betterauth` · `nextauth` · `supabase` · `none` | `clerk` |
-| `--social-login` | `wechat,qq,dingtalk,workweixin,feishu,weibo` (comma-sep) | none |
-| `--payment` | `stripe` · `lemon` · `wechat` · `alipay` · `none` | region-based |
-| `--ai` | expert/non-interactive provider seed, comma-separated ids; omit it to use the governed gateway topology | gateway seed |
-| `--email` | `resend` · `postmark` · `ses` · `aliyun-dm` · `tencent-ses` · `netease` · `none` | region-based |
-| `--storage` | `r2` · `s3` · `supabase-storage` · `aliyun-oss` · `tencent-cos` · `qiniu` · `none` | region-based |
-| `--monitoring` | `sentry` · `datadog` · `aliyun-arms` · `tingyun` · `none` | region-based |
-| `--analytics` | `posthog` · `plausible` · `umami` · `baidu` · `sensors` · `none` | region-based |
-| `--sms` | `twilio` · `aliyun-sms` · `tencent-sms` · `yunpian` · `none` | region-based |
-| `--deploy` | `vercel` · `railway` · `cloudflare` · `selfhost` | `vercel` |
-| `--docs` | `fumadocs` · `mintlify` · `docusaurus` · `nextra` · `vitepress` · `none` | `fumadocs` |
-| `--orm` | `prisma` · `drizzle` · `none` | `prisma` |
-| `--db` | `postgres` · `mysql` · `sqlite` · `none` | `postgresql` |
-| `--queue` | `qstash` · `bullmq` · `upstash` · `sqs` · `none` | region-based |
-| `--search` | `meilisearch` · `typesense` · `algolia` · `pgvector` · `none` | region-based |
-| `--cache` | `upstash-redis` · `vercel-kv` · `redis` · `dragonfly` · `none` | region-based |
-| `--notifications` | `novu` · `knock` · `custom` · `none` | `none` |
-| `--webhooks` | `svix` · `custom` · `none` | `none` |
-| `--cms` | `sanity` · `contentful` · `strapi` · `none` | `none` |
-| `--feature-flags` | `vercel-flags` · `growthbook` · `configcat` · `none` | `none` |
-| `--captcha` | `turnstile` · `hcaptcha` · `aliyun-slide` · `none` | region-based |
-| `--mcp` | `on` · `off` | `on` |
-| `--metering` | `auto` · `on` · `off` | `auto` |
-| `--billing-mode` | `usage` · `seat` · `credits` | `usage` |
-| `--idp` | `clerk` · `oauth-server` | `clerk` |
-| `--access-gate` | `none` · `invite` | `none` |
-| `--cron-jobs` | `true` · `false` — scaffold scheduled cron handlers | `true` |
-| `--audit-log` | `true` · `false` — enable `/settings/audit-log` + arch test | `false` (`@nebutra/audit` is WIP) |
-| `--api-keys` | `true` · `false` — enable `/settings/api-keys` page | `true` |
-| `--command-palette` | `true` · `false` — enable ⌘K command palette | `true` |
-| `--cookie-consent` | `true` · `false` — enable GDPR/CCPA cookie banner | `true` |
-| `--legal-pages` | `true` · `false` — enable dynamic `/legal/[slug]` route | `true` |
-| `--china-compliance` | `true` · `false` — enable `@nebutra/china-compliance` + ICP footer | `true` when `--region=cn`, otherwise `false` |
-| `--i18n / --no-i18n` | boolean | `true` |
-| `-y, --yes` | accept all defaults (non-interactive) | — |
-| `--dry-run` | preview actions without writing | — |
-| `--json` | machine-readable output | — |
-
-`--deploy` remains a bootstrap shortcut. The generated project also writes a
-provider-switchable `deployTargets` map into `nebutra.config.json` and appends
-matching `DEPLOY_TARGET_*` values to `.env.example`:
-
-- `vercel` → Vercel frontends, Cloudflare Workers gateway, ECS Docker origin
-- `cloudflare` → Cloudflare Pages frontends, Cloudflare Workers gateway, ECS Docker origin
-- `railway` → Railway for frontends, gateway, and origin
-- `selfhost` → standalone frontends, ECS/Docker-style gateway and origin
-
-## Region Presets
-
-| Region | Email | Storage | Analytics | Monitoring | SMS | Payment |
-|--------|-------|---------|-----------|------------|-----|---------|
-| `global` | Resend | R2 | PostHog | Sentry | Twilio | Stripe |
-| `cn` | Alibaba Cloud DirectMail | Alibaba Cloud OSS | Baidu Analytics | Sentry | Alibaba Cloud SMS | WeChat Pay |
-| `hybrid` | Resend | Alibaba Cloud OSS | PostHog | Sentry | Alibaba Cloud SMS | Stripe |
-
-## Social login (CN)
-
-Adding `--social-login=wechat,dingtalk` extends your primary auth provider
-(Clerk or Better Auth) with China-region OAuth:
-
-- Generates `apps/web/src/app/api/auth/callback/<id>/route.ts` stubs with the
-  correct token-exchange endpoints (WeChat / QQ / DingTalk / WeCom / Feishu / Weibo)
-- Generates `apps/web/src/components/auth/SocialLoginButtons.tsx` with one
-  button per selected provider
-- Appends all required env vars to `.env.example`
-
-The primary auth provider still owns user/session lifecycle — the generated
-callbacks exchange `code` for provider access tokens and leave a
-intentional SAMPLE marker for primary-auth upsert for the user to wire up.
+Options: `--pm`, `--no-install`, `--no-git`, `--yes`, `--dry-run`, `--json`,
+`--no-color`. There are no stack flags.
 
 ## After Scaffolding
 
 ```bash
 cd my-app
-pnpm install
-# create .env.local and add your provider credentials
+pnpm infra:up      # local Postgres (optional)
 pnpm db:migrate
-pnpm db:seed
 pnpm dev
+nebutra status     # what is live, what needs a key
 ```
 
-Useful follow-ups:
-
-```bash
-pnpm brand:init
-pnpm brand:apply
-pnpm generate:api-types
-```
+Deploy anywhere: the project builds Next `standalone` output and ships
+Dockerfiles. The scaffold does not choose a platform for you.
 
 ## Why Sailor?
 
@@ -181,14 +81,13 @@ single monorepo you can extend instead of re-assembling from scratch.
 ## Roadmap
 
 - **Verified scaffolding** — immutable template delivery, scaffold smoke validation, and safer bootstrap defaults
-- **Remote feature registry** — `nebutra add` with compatibility checks, provider awareness, and controlled file application
 - **Harness runtime** — stronger MCP, agent, and automation primitives for AI-native SaaS workflows
 - **Upgrade path** — version-aware migrations, diagnostics, and guided adoption of new platform capabilities
 
 ## Documentation
 
-- **Getting Started**: [docs.nebutra.com/getting-started/installation](https://docs.nebutra.com/getting-started/installation)
-- **Customization Guide**: [docs.nebutra.com/customization/overview](https://docs.nebutra.com/customization/overview)
+- **Getting Started**: [nebutra.com/docs/getting-started/installation](https://nebutra.com/docs/getting-started/installation)
+- **Customization Guide**: [nebutra.com/docs/customization/overview](https://nebutra.com/docs/customization/overview)
 - **Licensing**: [nebutra.com/licensing](https://nebutra.com/licensing)
 
 ## License