mythik-cli 0.1.0 → 0.1.2

package/README.md

@@ -1,6 +1,25 @@
 # mythik-cli
 
-Command-line tooling for Mythik specs.
+The AI-first surface to Mythik. The `mythik` command and its
+programmatic sibling (`mythik-cli/api`) are how an AI agent — or a
+human — reads, validates, patches, versions, and promotes Mythik
+specs.
+
+> See [the framework README on GitHub](https://github.com/mldixdev/mythik#readme)
+> for the full Mythik architecture and design philosophy. This file
+> documents what `mythik-cli` gives you and how to use it.
+
+---
+
+## What Mythik is, briefly
+
+Mythik is an **AI-first, spec-driven framework**. Every UI screen and
+API endpoint lives as a JSON spec in a database — not a `.tsx` file
+in a repo. Apps grow by adding rows, not files. The framework
+validates every change atomically, versions everything automatically,
+and promotes between environments (`dev`, `staging`, `production`) by
+atomic pointer move. Your favorite AI agent drives the full workflow
+through this CLI — no GUI in the loop.
 
 ## Install
 
@@ -14,58 +33,167 @@ The package exposes the `mythik` binary:
 npx mythik --help
 ```
 
-## Common Commands
-
-```bash
-npx mythik docs path
-npx mythik docs copy ./mythik-docs
-npx mythik manifest home
-npx mythik elements home root,submit-button
-npx mythik validate home
-npx mythik patch home --from-file patch.json
-npx mythik push home --from-file home.json
-npx mythik pull home
-npx mythik lint --from-file home.json
-npx mythik contract --app app-demo --api api-demo
+## The canonical workflow
+
+The Mythik loop is four steps, all served by this package:
+
+```
+       ┌──────────────────────────────────────────────────┐
+       │                                                  │
+       ▼                                                  │
+   manifest  ──▶  elements  ──▶  patch  ──▶  observe
+   (read           (read just     (RFC 6902      (the
+    structure)      what you       diff;           next
+                    need)          atomic          manifest)
+                                   validation
+                                   on push)
+```
+
+Each step is one command:
+
+```bash
+# 1. Read structure
+$ npx mythik manifest task-manager
+
+# 2. Read just the elements you need (use --toon for token-efficient output)
+$ npx mythik elements task-manager task-row,new-task-form --json
+
+# 3. Apply a patch (validates atomically; rejected if it breaks the contract)
+$ npx mythik patch task-manager --from-file add-due-date.json --author claude
+✓ Patch applied. v3 → v4. 4 elements modified.
+
+# 4. Observe — read the new structure
+$ npx mythik manifest task-manager
+```
+
+When `patch` fails (the candidate breaks the contract), the gate
+returns structured diagnostics: rule IDs, paths, suggestion text. The
+agent reads the error, refines the patch, and retries. No half-baked
+write ever lands.
+
+## Moving across environments
+
+`dev`, `staging`, `production` are not deploy targets — they are
+pointers to specific versions of a spec. Move them with `envs`;
+promote across them atomically with `promote`:
+
+```bash
+# Move the dev pointer to the new version
+$ npx mythik envs task-manager --set dev=4 --author claude
+
+# Promote dev → production (validates atomically; rejected if inconsistent)
+$ npx mythik promote task-manager --from dev --to production --confirm --author mldix
+✓ Validated against contract.
+✓ Cross-screen consistency check passed.
+✓ Pointer moved: production v3 → v4.
+
+# List current environment pointers
+$ npx mythik envs task-manager --json
+```
+
+## Read-only previews
+
+For drafts and audits *outside* the canonical loop:
+
+```bash
+# Validate a stored spec (read-only check; no write)
+$ npx mythik validate task-manager
+
+# Lint a local file (draft not yet pushed) or a directory
+$ npx mythik lint --from-file draft.json
+$ npx mythik lint --from-dir ./specs
+
+# Cross-validate a frontend spec against an ApiSpec (catches drift before deploy)
+$ npx mythik contract --app app-demo --api api-demo
+```
+
+All three run the same validators that `patch` and `promote` enforce
+atomically — useful when constructing complex multi-step changes
+locally before committing to a push.
+
+## History and rollback
+
+```bash
+# Show version history with structural diffs
+$ npx mythik history task-manager
+
+# Compare two versions or two environments
+$ npx mythik diff task-manager 3 4
+$ npx mythik diff task-manager dev production
+
+# Always-forward rollback (creates a new version with old content)
+$ npx mythik rollback task-manager --to 3 --author mldix
 ```
-
-Use `--json` for machine-readable output and `--toon` where supported for token-efficient agent workflows.
-
-## AI Documentation
-
-`mythik` bundles the AI documentation corpus inside the core package. Use:
-
-```bash
-npx mythik docs path
-```
-
-Point the AI agent at the printed directory before asking it to create or modify Mythik specs. To copy the docs into a
-project-local folder:
-
-```bash
-npx mythik docs copy ./mythik-docs
-```
+
+Rollback never rewrites history. The new version `v5` will hold the
+content of `v3`. `v4` stays in the history with its own author and
+timestamp.
+
+## Output formats
+
+| Flag | When to use |
+|---|---|
+| `--json` | Machine-readable output for scripts and IDE integrations |
+| `--toon` (where supported) | Token-efficient agent reads — same shape, fewer tokens, useful for paginating large manifests or element catalogs |
 
 ## Programmatic API
 
-Use `mythik-cli/api` when a script, IDE integration, or AI agent should avoid shell quoting issues:
+When a script, IDE integration, or AI agent should avoid shell
+quoting, use `mythik-cli/api`:
 
 ```ts
-import { runPatch, runPush, runLint } from 'mythik-cli/api';
+import { runPatch, runValidate, runPromote } from 'mythik-cli/api';
 
-await runPatch({
-  screen: 'home',
-  fromFile: 'patch.json',
+const result = await runPatch({
+  screen: 'task-manager',
+  fromFile: 'add-due-date.json',
+  author: 'claude',
   json: true,
 });
+
+if (!result.ok) {
+  console.error(result.diagnostics);
+}
 ```
 
-The programmatic API uses the same implementation path as the CLI.
+The programmatic API uses the same implementation path as the binary —
+nothing is special-cased. Whatever the CLI does, the API does
+identically.
 
-## License
+## Bundled AI documentation
 
-Apache-2.0.
+The `mythik` package (peer dependency) ships canonical AI docs at
+`node_modules/mythik/docs/`. Locate or copy them:
+
+```bash
+$ npx mythik docs path
+/your-project/node_modules/mythik/docs
+
+$ npx mythik docs copy ./mythik-docs
+```
+
+Point your AI agent at the printed path before asking it to author or
+modify specs. Inside that directory:
+
+- `consumer/ai-context.md` — spec-generation primer (rules and traps)
+- `consumer/ai-context-primitives.md` — every primitive's props
+- `consumer/reference-doc.md` — full rule catalog
+- `wiki/compiled/` — atomic per-concept articles (one page per action,
+  primitive, rule, expression) optimized for AI lookup
+- `llms.txt` — index for AI tools that read it
+
+## Related packages
+
+- [`mythik`](https://github.com/mldixdev/mythik/tree/main/packages/core#readme) — the runtime this CLI manipulates
+- [`mythik-react`](https://github.com/mldixdev/mythik/tree/main/packages/react#readme) — render the specs as a React app
+- [`mythik-server`](https://github.com/mldixdev/mythik/tree/main/packages/server#readme) — declarative REST server from an `ApiSpec`
 
 ## Status
 
-v0.1.0 public release. The binary name is `mythik`; the npm package name is `mythik-cli`.
+`v0.1.2` public release. The binary name is `mythik`; the npm package
+name is `mythik-cli`. APIs are documented for real-world feedback as
+the framework evolves.
+
+## License
+
+Apache-2.0.

package/dist/cli.js

@@ -26,7 +26,7 @@ const program = new Command();
 program
     .name('mythik')
     .description('Mythik CLI — manage specs via SpecEngine')
-    .version('0.1.0');
+    .version('0.1.2');
 program
     .command('manifest <screen>')
     .description('Show structural tree of a screen spec')

package/package.json

@@ -1,65 +1,66 @@
-{
-  "name": "mythik-cli",
-  "version": "0.1.0",
-  "description": "Command-line and programmatic tooling for validating, linting, pushing, patching, and versioning Mythik specs.",
-  "license": "Apache-2.0",
-  "type": "module",
-  "bin": {
-    "mythik": "dist/cli.js"
-  },
-  "main": "dist/cli.js",
-  "keywords": [
-    "mythik",
-    "cli",
-    "json",
-    "spec-driven",
-    "validation",
-    "lint",
-    "ai"
-  ],
-  "homepage": "https://mythik.dev",
-  "bugs": {
-    "url": "https://github.com/mldixdev/mythik/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/mldixdev/mythik.git",
-    "directory": "packages/cli"
-  },
-  "files": [
-    "dist",
-    "LICENSE",
-    "NOTICE"
-  ],
-  "exports": {
-    ".": {
-      "types": "./dist/cli.d.ts",
-      "default": "./dist/cli.js"
-    },
-    "./api": {
-      "types": "./dist/api.d.ts",
-      "default": "./dist/api.js"
-    },
-    "./package.json": "./package.json"
-  },
-  "scripts": {
-    "build": "node ../../node_modules/typescript/bin/tsc",
-    "typecheck": "node ../../node_modules/typescript/bin/tsc --noEmit",
-    "prepack": "pnpm build"
-  },
-  "dependencies": {
-    "@inquirer/prompts": "^7.0.0",
-    "mythik": "workspace:*",
-    "@toon-format/toon": "^2.1.0",
-    "commander": "^13.0.0"
-  },
-  "devDependencies": {
-    "@types/node": "^25.5.2"
-  },
-  "peerDependencies": {
-    "typescript": ">=5.0.0"
-  },
-  "peerDependenciesMeta": {
-    "typescript": { "optional": true }
-  }
-}
+{
+  "name": "mythik-cli",
+  "version": "0.1.2",
+  "description": "Command-line and programmatic tooling for validating, linting, pushing, patching, and versioning Mythik specs.",
+  "license": "Apache-2.0",
+  "type": "module",
+  "bin": {
+    "mythik": "dist/cli.js"
+  },
+  "main": "dist/cli.js",
+  "keywords": [
+    "mythik",
+    "cli",
+    "json",
+    "spec-driven",
+    "validation",
+    "lint",
+    "ai"
+  ],
+  "homepage": "https://mythik.dev",
+  "bugs": {
+    "url": "https://github.com/mldixdev/mythik/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mldixdev/mythik.git",
+    "directory": "packages/cli"
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "NOTICE"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/cli.d.ts",
+      "default": "./dist/cli.js"
+    },
+    "./api": {
+      "types": "./dist/api.d.ts",
+      "default": "./dist/api.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "@inquirer/prompts": "^7.0.0",
+    "@toon-format/toon": "^2.1.0",
+    "commander": "^13.0.0",
+    "mythik": "0.1.2"
+  },
+  "devDependencies": {
+    "@types/node": "^25.5.2"
+  },
+  "peerDependencies": {
+    "typescript": ">=5.0.0"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
+  },
+  "scripts": {
+    "build": "node ../../node_modules/typescript/bin/tsc",
+    "typecheck": "node ../../node_modules/typescript/bin/tsc --noEmit"
+  }
+}