create-projx 1.3.6 → 1.4.1

package/README.md

@@ -126,6 +126,13 @@ npx create-projx <name> [options]
 npx create-projx init
 npx create-projx add <components...>
 npx create-projx update
+npx create-projx diff
+npx create-projx pin <patterns...>
+npx create-projx unpin <patterns...>
+npx create-projx pin --list
+npx create-projx doctor [--fix]
+npx create-projx gen entity <name>
+npx create-projx sync [--url <url>]
 
 --components <list>    Comma-separated: fastapi,fastify,frontend,mobile,e2e,infra
 --no-git               Skip git init
@@ -134,6 +141,81 @@ npx create-projx update
 -h, --help             Show help
 ```
 
+### Preview Changes
+
+See what `update` would change before applying:
+
+```bash
+cd my-app
+npx create-projx diff
+```
+
+Shows file-by-file analysis: clean updates, files needing merge, user-only changes, and skipped files.
+
+### Pin / Unpin Files
+
+Skip files from future template updates without editing JSON:
+
+```bash
+npx create-projx pin backend/pyproject.toml      # skip this file
+npx create-projx pin "backend/src/**"             # skip with glob
+npx create-projx unpin backend/pyproject.toml     # allow updates again
+npx create-projx pin --list                       # show all pinned files
+```
+
+Files inside a component directory are added to that component's `.projx-component` skip list. Root-level files are added to `.projx` skip.
+
+### Health Check
+
+Diagnose issues with your projx setup:
+
+```bash
+npx create-projx doctor         # check everything
+npx create-projx doctor --fix   # auto-fix what's possible
+```
+
+Checks: config validity, component markers, baseline ref, stale worktrees, skip pattern coverage.
+
+### Generate Entities
+
+Scaffold a new entity across all components in your project:
+
+```bash
+npx create-projx gen entity invoice                                          # interactive
+npx create-projx gen entity invoice --fields "name:string,amount:number"     # non-interactive
+```
+
+Generates based on what's in your `.projx`:
+
+| Component | Generated |
+| --------- | --------- |
+| `fastapi` | `src/entities/<name>/_model.py` — auto-discovered by registry |
+| `fastify` | `src/modules/<name>/schemas.ts` + `index.ts` + Prisma model + app.ts import |
+| `frontend` | `src/types/<name>.ts` — TypeScript interface + Create/Update variants |
+| `mobile` | `lib/entities/<name>/model.dart` — Dart class with fromJson/toJson/copyWith |
+
+No migrations — run `alembic revision --autogenerate` or `npx prisma migrate dev` when ready.
+
+### Sync Types
+
+Regenerate all frontend/mobile types from a running backend:
+
+```bash
+npx create-projx sync                                              # auto-detects URL
+npx create-projx sync --url http://localhost:8000/api/v1/_meta      # explicit URL
+```
+
+Fetches `/_meta` from your backend, generates typed interfaces for every entity. Run after any backend change — new field, renamed column, new entity.
+
+The generic `api.ts` client accepts type parameters:
+
+```tsx
+import type { Invoice } from '../types/invoice';
+
+const { data } = await api.list<Invoice>('/invoices');    // data: Invoice[]
+const item = await api.get<Invoice>('/invoices', id);     // item: Invoice
+```
+
 ## Rename Component Directories
 
 Rename `fastapi/` to `backend/`? Just rename the folder — the `.projx-component` marker file moves with it. The `update` command auto-discovers where each component lives by scanning for these markers. No config changes needed.