Update hivegrid-cloud reference to latest main
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
1 parent
e98d38e716
commit
7b21524c86
3781 files changed
+373484
-225607
No files matched your search
@@ -1,4 +1,4 @@
|
||||
# CLI scaffolding (`toolctrl create` / `toolctrl add`)
|
||||
# CLI scaffolding (`hivegrid create` / `hivegrid add`)
|
||||
|
||||
The operator CLI under `packages/cli/` ships scaffolding generators that
|
||||
emit minimal, opinionated skeletons for the most common boilerplate
|
||||
@@ -9,15 +9,15 @@ chores. Each generator writes to **new paths only** and supports a
|
||||
|
||||
```bash
|
||||
# from the repo root, after `pnpm install`
|
||||
pnpm --filter @toolctrl/cli build
|
||||
pnpm --filter @hivegrid/cli build
|
||||
|
||||
# show the full command tree
|
||||
node packages/cli/bin/toolctrl-cli.mjs --help
|
||||
node packages/cli/bin/hivegrid-cli.mjs --help
|
||||
```
|
||||
|
||||
## Command reference
|
||||
|
||||
### `toolctrl create module <name>`
|
||||
### `hivegrid create module <name>`
|
||||
|
||||
Scaffolds a feature-module skeleton under `apps/web/app/modules/<name>/`:
|
||||
|
||||
@@ -36,7 +36,7 @@ Flags:
|
||||
Example:
|
||||
|
||||
```bash
|
||||
node packages/cli/bin/toolctrl-cli.mjs create module inventory
|
||||
node packages/cli/bin/hivegrid-cli.mjs create module inventory
|
||||
```
|
||||
|
||||
Manual follow-up (the README in the generated module repeats this):
|
||||
@@ -45,10 +45,10 @@ Manual follow-up (the README in the generated module repeats this):
|
||||
2. Replace the `TODO` markers in the db layer.
|
||||
3. Add the permission keys to
|
||||
`packages/db/src/permissions-seed.server.ts` (see
|
||||
`toolctrl add permission` below).
|
||||
`hivegrid add permission` below).
|
||||
4. Run `pnpm typecheck` to generate the route types.
|
||||
|
||||
### `toolctrl create route <filename>`
|
||||
### `hivegrid create route <filename>`
|
||||
|
||||
Scaffolds a single React-Router-v7 route file at
|
||||
`apps/web/app/routes/<filename>.tsx` plus a co-located vitest stub.
|
||||
@@ -61,7 +61,7 @@ Flags:
|
||||
Example:
|
||||
|
||||
```bash
|
||||
node packages/cli/bin/toolctrl-cli.mjs create route app.\$tenant.dashboard
|
||||
node packages/cli/bin/hivegrid-cli.mjs create route app.\$tenant.dashboard
|
||||
```
|
||||
|
||||
The generated file imports `Route` types from `./+types/<filename>`
|
||||
@@ -69,7 +69,7 @@ The generated file imports `Route` types from `./+types/<filename>`
|
||||
and an `ErrorBoundary` export. Run `pnpm typecheck` after generation
|
||||
to populate the `./+types/` directory.
|
||||
|
||||
### `toolctrl create entity <name>`
|
||||
### `hivegrid create entity <name>`
|
||||
|
||||
Emits a Prisma model snippet plus a timestamped migration directory:
|
||||
|
||||
@@ -89,21 +89,21 @@ pnpm prisma migrate dev --name create_entity_<name>
|
||||
pnpm prisma generate
|
||||
```
|
||||
|
||||
### `toolctrl add hook <name>`
|
||||
### `hivegrid add hook <name>`
|
||||
|
||||
Scaffolds a plugin-hook registration file under
|
||||
`apps/web/app/hooks/_generated/`. The output is a **forward-compatible
|
||||
stub** for generated hook registration. The plugin runtime and
|
||||
`@toolctrl/plugin-sdk` now exist; keep generated hooks on the scaffolded
|
||||
`@hivegrid/plugin-sdk` now exist; keep generated hooks on the scaffolded
|
||||
no-op shape until a focused task wires that specific hook into the runtime.
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
node packages/cli/bin/toolctrl-cli.mjs add hook onContactCreated
|
||||
node packages/cli/bin/hivegrid-cli.mjs add hook onContactCreated
|
||||
```
|
||||
|
||||
### `toolctrl add event-type <name>`
|
||||
### `hivegrid add event-type <name>`
|
||||
|
||||
Scaffolds an EntityWebhook event-type definition with a zod schema, an
|
||||
example payload, and an async handler stub under
|
||||
@@ -113,10 +113,10 @@ names MUST be dotted lowercase, e.g. `crm.contact.created`.
|
||||
Example:
|
||||
|
||||
```bash
|
||||
node packages/cli/bin/toolctrl-cli.mjs add event-type crm.contact.created
|
||||
node packages/cli/bin/hivegrid-cli.mjs add event-type crm.contact.created
|
||||
```
|
||||
|
||||
### `toolctrl add permission <name>`
|
||||
### `hivegrid add permission <name>`
|
||||
|
||||
Scaffolds two fragments for a new permission key:
|
||||
|
||||
@@ -132,7 +132,7 @@ README notes spell out the manual paste step.
|
||||
Example:
|
||||
|
||||
```bash
|
||||
node packages/cli/bin/toolctrl-cli.mjs add permission app.inventory.view
|
||||
node packages/cli/bin/hivegrid-cli.mjs add permission app.inventory.view
|
||||
```
|
||||
|
||||
## Safety guarantees
|
||||
|
||||
Reference in new issue
Block a user