@creatorem/cli 1.0.4 → 1.0.5

package/README.md

@@ -0,0 +1,148 @@
+# Creatorem CLI
+
+`@creatorem/cli` is the automation layer for shaping Creatorem projects fast.
+
+It can:
+- scaffold a full monorepo from template (`create`)
+- add or edit a dashboard app (`create-dashboard`)
+- add or edit a mobile app (`create-mobile`)
+- strip unused features cleanly across app + repo scope
+- generate SQL schema files from JSON (`generate-schemas`)
+- generate a migration from schema folders (`generate-migration`)
+
+## Why this CLI is powerful
+
+- **Feature-driven architecture control**: keep only the modules you want.
+- **Deep cleanup**: not just UI toggles; removes imports, routes, config, files, package deps, and (optionally) repo-level kit/supabase assets.
+- **Template auto-selection**: automatically uses premium template when access exists, otherwise OSS.
+- **Multi-app orchestration**: in one flow you can decide marketing/dashboard/mobile/example composition.
+- **Language bootstrap**: manages locales and language config files.
+- **Machine-readable metadata**: writes selection manifests to `.creatorem/`.
+
+## Commands
+
+```bash
+creatorem create
+creatorem create-dashboard <name>
+creatorem create-mobile <name>
+creatorem generate-schemas [input] [output]
+creatorem generate-migration
+creatorem help
+```
+
+## Key options
+
+These are primarily relevant for `create-dashboard` and `create-mobile`:
+
+- `--features <comma-separated-keys>`: keep only these feature keys
+- `--edit`: edit the current app in place (inside existing monorepo)
+- `--repo-scope`: also remove repo-level feature assets (`kit/*`, supabase schemas, workspace deps)
+
+Examples:
+
+```bash
+creatorem create-dashboard my-dashboard --features ai,keybindings
+creatorem create-dashboard --edit --features ai,analytics,monitoring --repo-scope
+creatorem create-mobile my-mobile --features organization,onboarding
+creatorem create-mobile --edit --features notification --repo-scope
+```
+
+## Selectable features
+
+### Dashboard (`create-dashboard`)
+
+Feature keys accepted by `--features`:
+
+- `organization`
+- `keybindings`
+- `analytics`
+- `monitoring`
+- `ai`
+- `notification`
+- `billing`
+- `content-type`
+- `onboarding`
+- `email-templates`
+- `emailer`
+
+What each feature includes:
+
+- `organization`: org/member/role management and org-aware hooks/components
+- `keybindings`: keyboard shortcut model + settings UI + hooks
+- `analytics`: Google Analytics / Umami integration
+- `monitoring`: Sentry instrumentation integration
+- `ai`: AI chat UI, tools integration, usage/wallet tracking
+- `notification`: notification UI + DB router integration
+- `billing`: Stripe/Lemon Squeezy + billing settings + wallet/subscription flows
+- `content-type`: premade table-oriented UI + command/search helpers
+- `onboarding`: post-signup onboarding flow
+- `email-templates`: React Email templates module
+- `emailer`: transactional email providers (Nodemailer, Postmark, Resend, Sendgrid)
+
+### Mobile (`create-mobile`)
+
+Feature keys accepted by `--features`:
+
+- `organization`
+- `notification`
+- `onboarding`
+
+What each feature includes:
+
+- `organization`: org/member/role management + org hooks
+- `notification`: mobile notification UI + related backend router wiring
+- `onboarding`: post-signup onboarding flow for mobile
+
+## Customization matrix
+
+### `create` (full monorepo wizard)
+
+You can customize:
+- project name
+- git initialization
+- include/exclude apps: marketing, dashboard, mobile
+- per-app feature sets (dashboard + mobile)
+- include example apps (detected from template repo)
+- language set:
+  - English always included
+  - French selectable by default
+  - extra custom language codes (comma-separated)
+
+It also:
+- updates locale directories from `en` templates
+- updates `packages/shared/src/config/defined-languages.ts`
+- updates mobile i18n config based on selected languages/features
+- writes root manifest at `.creatorem/monorepo.json`
+
+### `create-dashboard` / `create-mobile`
+
+Modes:
+- **inside existing monorepo**: copies from `apps/dashboard` or `apps/mobile`, or edits in place with `--edit`
+- **outside monorepo**: clones template, keeps relevant apps, applies cleanup, and outputs a trimmed monorepo
+
+Additional behavior:
+- generates `.env.template` (and `.env` when appropriate) from app `envs.ts`
+- writes app-level manifest `.creatorem/features.json`
+- with `--repo-scope`, also removes repo-level feature assets and uninstalls related workspace dependencies
+
+## SQL generators
+
+### `generate-schemas`
+
+- Input:
+  - JSON string, or
+  - path to `setup.json`, or
+  - directory containing `setup.json` (default: `.creatorem`)
+- Output directory:
+  - default: `supabase/app-schemas`
+  - optional second arg for custom output path
+- Also copies extra SQL files from `<inputDir>/schemas` when present
+
+### `generate-migration`
+
+- Combines SQL from:
+  - `supabase/schemas`
+  - `supabase/app-schemas`
+- Produces:
+  - `supabase/migrations/<timestamp>_generated_from_schemas.sql`
+- Replaces previous generated migration files with fresh output.