@tailor-platform/erp-kit 0.1.0 → 0.1.2

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# @tailor-platform/erp-kit
+
+## 0.1.2
+
+### Patch Changes
+
+- 0c9a2e5: CQRS query support and app/module subcommands
+
+## 0.1.1
+
+### Patch Changes
+
+- 2f43392: Add MIT LICENSE and include CHANGELOG.md in published package

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright © 2025 Tailor Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -11,18 +11,23 @@ npm install @tailor-platform/erp-kit
 ## Quick Start
 
 ```bash
-# Set up your repo (agent skills, rules)
+# Set up your repo (agent skills)
 erp-kit init
 
-# Validate docs against schemas
-erp-kit check --modules-root modules
-erp-kit check --app-root examples
+# List available modules
+erp-kit module list
+
+# Validate module docs against schemas
+erp-kit module check --root src/modules
 
 # Check source ↔ doc correspondence
-erp-kit sync-check --modules-root modules
+erp-kit module sync-check --root src/modules
+
+# Generate a new module doc from template
+erp-kit module scaffold command inventory createOrder --root src/modules
 
-# Generate a new doc from template
-erp-kit scaffold --modules-root modules <type> <parent> [name]
+# Validate app docs
+erp-kit app check --root examples
 
 # Start mock API servers
 erp-kit mock start
@@ -33,47 +38,76 @@ erp-kit mock validate
 
 ## Commands
 
-### `check`
+### `module`
+
+Module documentation management.
+
+#### `module list`
 
-Validates markdown documentation against YAML schemas.
+Lists all available modules with command, model, and feature counts.
 
 ```bash
-erp-kit check --modules-root modules
-erp-kit check --app-root examples
-erp-kit check --modules-root modules --app-root examples
+erp-kit module list
 ```
 
-### `sync-check`
+#### `module check`
 
-Ensures every source file has a corresponding doc and vice versa. Detects missing and orphaned documentation.
+Validates module markdown documentation against YAML schemas.
 
 ```bash
-erp-kit sync-check --modules-root modules
-erp-kit sync-check --app-root examples
+erp-kit module check --root src/modules
 ```
 
-### `scaffold`
+#### `module sync-check`
+
+Ensures every source file has a corresponding doc and vice versa.
+
+```bash
+erp-kit module sync-check --root src/modules
+```
+
+#### `module scaffold`
 
 Generates documentation files from schema templates.
 
-**Module types:**
+```bash
+erp-kit module scaffold module inventory --root src/modules
+erp-kit module scaffold feature inventory stock-tracking --root src/modules
+erp-kit module scaffold command inventory createOrder --root src/modules
+erp-kit module scaffold model inventory StockItem --root src/modules
+```
+
+### `app`
+
+App-compose documentation management.
+
+#### `app check`
+
+Validates app documentation against YAML schemas.
 
 ```bash
-erp-kit scaffold --modules-root modules module inventory
-erp-kit scaffold --modules-root modules feature inventory stock-tracking
-erp-kit scaffold --modules-root modules command inventory CreateOrder
-erp-kit scaffold --modules-root modules model inventory StockItem
+erp-kit app check --root examples
 ```
 
-**App-compose types:**
+#### `app sync-check`
+
+Ensures every source file has a corresponding doc and vice versa.
 
 ```bash
-erp-kit scaffold --app-root examples requirements my-app
-erp-kit scaffold --app-root examples actors my-app admin
-erp-kit scaffold --app-root examples business-flow my-app onboarding
-erp-kit scaffold --app-root examples story my-app onboarding/admin--create-user
-erp-kit scaffold --app-root examples screen my-app supplier-list
-erp-kit scaffold --app-root examples resolver my-app create-supplier
+erp-kit app sync-check --root examples
+```
+
+#### `app scaffold`
+
+Generates documentation files from schema templates.
+
+```bash
+erp-kit app scaffold requirements my-app --root examples
+erp-kit app scaffold actors my-app admin --root examples
+erp-kit app scaffold business-flow my-app onboarding --root examples
+erp-kit app scaffold story my-app onboarding/admin--create-user --root examples
+erp-kit app scaffold screen my-app supplier-list --root examples
+erp-kit app scaffold resolver my-app create-supplier --root examples
 ```
 
 ### `mock start`
@@ -124,32 +158,31 @@ One-time setup for consumer repos. Idempotent — skips files that already exist
 
 ```bash
 erp-kit init
+
+# Overwrite existing skills
+erp-kit init --force
 ```
 
 This will:
 
 1. Copy 12 agent skills to `.agents/skills/`
-2. Copy development rules to `.agents/rules/`
+2. Create symlink `.claude/skills` → `.agents/skills/`
 
 ## Options
 
-| Flag                    | Description                                               |
-| ----------------------- | --------------------------------------------------------- |
-| `--modules-root <path>` | Path to modules directory (required for module commands)  |
-| `--app-root <path>`     | Path to app-compose directory (required for app commands) |
-| `--mocks-root <path>`   | Path to mocks directory (default: `./mocks`)              |
-| `-p, --port <number>`   | Reverse proxy port for `mock start` (default: `3000`)     |
-
-At least one of `--modules-root` or `--app-root` is required for `check`, `sync-check`, and `scaffold`.
+| Flag                  | Alias | Applies to                                  | Description                                  |
+| --------------------- | ----- | ------------------------------------------- | -------------------------------------------- |
+| `--root <path>`       | `-r`  | `module check/sync-check/scaffold`, `app *` | Path to modules or app-compose directory     |
+| `--mocks-root <path>` |       | `mock start`, `mock validate`               | Path to mocks directory (default: `./mocks`) |
+| `--port <number>`     | `-p`  | `mock start`                                | Reverse proxy port (default: `3000`)         |
+| `--force`             | `-f`  | `init`                                      | Overwrite existing files (default: `false`)  |
 
 ## What's Bundled
 
-| Directory     | Contents                                                         |
-| ------------- | ---------------------------------------------------------------- |
-| `schemas/`    | YAML schema definitions for all doc types                        |
-| `sync-check/` | Source-to-doc mapping configs                                    |
-| `skills/`     | 12 agent skills for documentation, implementation, and mocking   |
-| `rules/`      | Development rules and best practices for modules and app-compose |
+| Directory  | Contents                                                       |
+| ---------- | -------------------------------------------------------------- |
+| `schemas/` | YAML schema definitions for all doc types                      |
+| `skills/`  | 12 agent skills for documentation, implementation, and mocking |
 
 ### Schemas
 
@@ -180,12 +213,6 @@ Mock workflow:
 
 1. `mock-scenario` — Scaffold a new Mockoon mock scenario with CRUD routes and error scenarios
 
-### Development Rules
-
-- `module-development/` — Structure, commands, models, executors, testing, exports, errors
-- `app-compose/` — App structure, frontend screens, components, auth patterns
-- `sdk-best-practices/` — Database relations, SDK documentation references
-
 ## Programmatic Mock Server
 
 The `createMockServer` helper starts a Mockoon server from a `mock.json` file, useful for integration tests: