@objectstack/cli 1.0.11 → 1.1.0

package/.turbo/turbo-build.log

@@ -1,19 +1,24 @@
 
-> @objectstack/cli@1.0.11 build /home/runner/work/spec/spec/packages/cli
+> @objectstack/cli@1.1.0 build /home/runner/work/spec/spec/packages/cli
 > tsup
 
-CLI Building entry: src/bin.ts, src/index.ts
+CLI Building entry: src/bin.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v8.5.1
+CLI Using tsup config: /home/runner/work/spec/spec/packages/cli/tsup.config.ts
+CLI Building entry: src/index.ts
 CLI Using tsconfig: tsconfig.json
 CLI tsup v8.5.1
 CLI Using tsup config: /home/runner/work/spec/spec/packages/cli/tsup.config.ts
 CLI Target: es2022
+CLI Target: es2022
+ESM Build start
 CLI Cleaning output folder
 ESM Build start
-ESM dist/bin.js            22.98 KB
-ESM dist/index.js          105.00 B
-ESM dist/chunk-2YXVEYO7.js 2.40 KB
-ESM ⚡️ Build success in 42ms
+ESM dist/index.js 61.35 KB
+ESM ⚡️ Build success in 69ms
+ESM dist/bin.js 63.96 KB
+ESM ⚡️ Build success in 68ms
 DTS Build start
-DTS ⚡️ Build success in 6657ms
-DTS dist/bin.d.ts   13.00 B
-DTS dist/index.d.ts 105.00 B
+DTS ⚡️ Build success in 4303ms
+DTS dist/index.d.ts 2.93 KB

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @objectstack/cli
 
+## 1.0.12
+
+### Patch Changes
+
+- chore: add Vercel deployment configs, simplify console runtime configuration
+- Updated dependencies
+  - @objectstack/spec@1.0.12
+  - @objectstack/core@1.0.12
+  - @objectstack/runtime@1.0.12
+  - @objectstack/objectql@1.0.12
+  - @objectstack/driver-memory@1.0.12
+  - @objectstack/plugin-hono-server@1.0.12
+
 ## 1.0.11
 
 ### Patch Changes

package/README.md

@@ -1,24 +1,143 @@
 # @objectstack/cli
 
-Command Line Interface for developing ObjectStack applications.
+Command Line Interface for building metadata-driven applications with the ObjectStack Protocol.
+
+## Installation
+
+```bash
+pnpm add -D @objectstack/cli
+```
+
+The CLI is available as `objectstack` or the shorter alias `os`.
+
+## Quick Start
+
+```bash
+# Initialize a new project
+os init my-app
+
+# Generate metadata
+os generate object task
+os generate view task
+os generate flow task
+
+# Validate configuration
+os validate
+
+# Start development server
+os dev
+
+# Compile for production
+os compile
+```
 
 ## Commands
 
-- **`os serve`**: Start the backend server.
-  - Auto-detects configuration.
-  - Auto-loads `ObjectQL` and `InMemoryDriver` if not specified.
-- **`os dev`**: Start in development mode (with watch).
-- **`os doctor`**: Check environment health.
-- **`os create`**: Scaffold new projects.
+### Development
+
+| Command | Description |
+|---------|-------------|
+| `os init [name]` | Initialize a new ObjectStack project in the current directory |
+| `os dev [package]` | Start development mode with hot reload |
+| `os serve [config]` | Start the ObjectStack server with plugin auto-detection |
+
+### Build & Validate
+
+| Command | Description |
+|---------|-------------|
+| `os compile [config]` | Compile configuration to a JSON artifact (`dist/objectstack.json`) |
+| `os validate [config]` | Validate configuration against the ObjectStack Protocol schema |
+| `os info [config]` | Display metadata summary (objects, fields, apps, agents, etc.) |
+
+### Scaffolding
+
+| Command | Description |
+|---------|-------------|
+| `os generate <type> <name>` | Generate metadata files (alias: `os g`) |
+| `os create <type> [name]` | Create a new package/plugin/example from template |
+
+Available generate types: `object`, `view`, `action`, `flow`, `agent`, `dashboard`, `app`
+
+### Quality
+
+| Command | Description |
+|---------|-------------|
+| `os test [files]` | Run Quality Protocol test scenarios against a running server |
+| `os doctor` | Check development environment health |
 
 ## Configuration
 
-The CLI looks for `objectstack.config.ts` in the current directory.
+The CLI looks for `objectstack.config.ts` (or `.js`, `.mjs`) in the current directory:
 
 ```typescript
-// objectstack.config.ts
-export default {
-    metadata: { ... },
-    plugins: [ ... ]
-}
+import { defineStack } from '@objectstack/spec';
+import * as objects from './src/objects';
+
+export default defineStack({
+  manifest: {
+    id: 'com.example.my-app',
+    namespace: 'my_app',
+    version: '1.0.0',
+    type: 'app',
+    name: 'My App',
+  },
+  objects: Object.values(objects),
+});
 ```
+
+## CLI Options
+
+### Global
+
+- `-v, --version` — Show version number
+- `-h, --help` — Show help
+
+### `os init`
+
+- `-t, --template <template>` — Template: `app` (default), `plugin`, `empty`
+- `--no-install` — Skip dependency installation
+
+### `os compile`
+
+- `-o, --output <path>` — Output path (default: `dist/objectstack.json`)
+- `--json` — Output compile result as JSON (for CI pipelines)
+
+### `os validate`
+
+- `--strict` — Treat warnings as errors
+- `--json` — Output result as JSON
+
+### `os serve`
+
+- `-p, --port <port>` — Server port (default: `3000`)
+- `--dev` — Run in development mode (load devPlugins, pretty logging)
+- `--no-server` — Skip starting HTTP server plugin
+
+### `os generate`
+
+- `-d, --dir <directory>` — Override target directory
+- `--dry-run` — Preview without writing files
+
+### `os info`
+
+- `--json` — Output as JSON
+
+### `os doctor`
+
+- `-v, --verbose` — Show fix suggestions for warnings
+
+## Typical Workflow
+
+```
+os init                          # 1. Create project
+os generate object customer      # 2. Add a Customer object
+os generate object order         # 3. Add an Order object  
+os generate view customer        # 4. Add a list view
+os validate                      # 5. Validate everything
+os dev                           # 6. Start dev server
+os compile                       # 7. Build for production
+```
+
+## License
+
+Apache-2.0