create-noy-db 0.9.0 → 0.10.0-pre.1

package/README.md

@@ -26,7 +26,7 @@ yarn create noy-db my-app
 bun  create noy-db my-app
 ```
 
-The wizard asks at most 5 questions — project name, adapter, sample data, starter template, and sync adapter — then writes a complete starter into `./my-app/`. Nothing is installed automatically: pick your package manager and run it yourself (the wizard closes by printing `cd <project>`, `pnpm install`, `pnpm dev`).
+The wizard asks at most 4 questions — project name, adapter, sample data, and starter template — then writes a complete starter into `./my-app/`. Nothing is installed automatically: pick your package manager and run it yourself (the wizard closes by printing `cd <project>`, `pnpm install`, `pnpm dev`).
 
 Four starter templates ship in the package:
 
@@ -34,7 +34,8 @@ Four starter templates ship in the package:
 |---|---|---|
 | `nuxt-default` | Nuxt 4 + Pinia | SSR + file-based routing — **the default** |
 | `vite-vue` | Vite + Vue 3 + Pinia | Client-side SPA, shorter install graph |
-| `vanilla` | Vite + TypeScript | No framework, smallest footprint |
+| `minimal` | Vite + TypeScript, one file | **Default.** hub + browser storage, put/get; add more with `noy-db add` |
+| `vanilla` | Vite + TypeScript | No framework, an invoice-table UI |
 | `electron` | Electron + Vue 3 | Desktop app with the `to-file` adapter — USB workflow |
 
 Skip the prompts with `--yes`:
@@ -120,9 +121,9 @@ Validation errors and stack traces stay in English regardless of language so bug
 
 ---
 
-## `noy-db` — the CLI tool
+## `noy-db` — the one command line
 
-The `noy-db` bin ships inside the same `create-noy-db` package. Install it as a dev dependency and it's available via `pnpm exec` / `npx`:
+The `noy-db` bin ships inside the same `create-noy-db` package; it is the only CLI you need after `npm create noy-db` (the former `@noy-db/cli` is a redirect to it). Install it as a dev dependency and it's available via `pnpm exec` / `npx`:
 
 ```bash
 pnpm add -D create-noy-db
@@ -134,16 +135,26 @@ pnpm exec noy-db <command>
 | Command | Purpose |
 |---|---|
 | `noy-db add <collection>` | Scaffold a new Pinia store + Vue page for a collection |
-| `noy-db add user <id> <role>` | Grant a new user access to a compartment |
-| `noy-db verify` | In-memory crypto round-trip integrity check |
-| `noy-db rotate` | Rotate DEKs for one or more collections |
-| `noy-db backup <target>` | Dump a compartment to an encrypted file |
-
-All commands that touch real compartments use the **file adapter** and require these flags:
+| `noy-db user add <id> <role>` | Grant a new user access to a vault |
+| `noy-db user rotate` | Rotate DEKs for one or more collections |
+| `noy-db backup <target>` | Dump a vault to an encrypted file |
+| `noy-db doctor crypto` | In-memory crypto round-trip check |
+| `noy-db pod inspect <file.noydb>` | Print a pod's header — no secret needed |
+| `noy-db pod verify <file.noydb>` | Verify a pod's integrity — no secret needed |
+| `noy-db describe <file.noydb>` | YAML/JSON schema audit of a pod |
+| `noy-db config validate <file>` | Sanity-check a `NoydbOptions` file |
+| `noy-db config scaffold --profile=<id>` | Topology skeleton to stdout, `.env` template to stderr |
+| `noy-db config profiles` | List the ten topology profiles |
+| `noy-db monitor <file>` | Live store metrics (the config's store must be metered) |
+| `noy-db inspect <file> --vault=<v>` | Terminal inspector — uses `@noy-db/in-devtools-tui` when installed |
+
+The old spellings `add user`, `rotate` and `verify` still work and print the new one.
+
+Commands that touch a real vault use the **file adapter** and take these flags:
 
 - `--dir <path>` — the data directory. Defaults to `./data`.
-- `--compartment <name>` — the compartment (tenant) name. Required.
-- `--user <id>` — your own user id in the compartment. Required.
+- `--vault <name>` — the vault (tenant) name. Required.
+- `--user <id>` — your own user id in the vault. Required.
 
 You'll be prompted for your secret at runtime. Secrets are never echoed, never logged, never written to disk, and cleared from process memory when the command exits.
 
@@ -160,14 +171,14 @@ pnpm exec noy-db add clients
 
 Refuses to overwrite existing files — if either target already exists, the command exits non-zero without touching anything. There's no `--force` flag; delete the old files manually if you want to regenerate.
 
-### `noy-db add user <userId> <role> [options]`
+### `noy-db user add <userId> <role> [options]`
 
-Grants a new user access to a compartment. Two secret prompts: yours (caller), then the new user's (with confirmation).
+Grants a new user access to a vault. Two secret prompts: yours (caller), then the new user's (with confirmation).
 
 ```bash
-pnpm exec noy-db add user accountant-ann operator \
+pnpm exec noy-db user add accountant-ann operator \
   --dir ./data \
-  --compartment demo-co \
+  --vault demo-co \
   --user owner-alice \
   --collections invoices:rw,clients:ro
 ```
@@ -184,27 +195,27 @@ Roles:
 
 For `operator` and `client`, the `--collections` flag is required. Format: `name1:rw,name2:ro,name3:rw`.
 
-### `noy-db verify`
+### `noy-db doctor crypto`
 
 Runs an end-to-end crypto round-trip against an in-memory adapter. No real data is touched; the command creates a throwaway compartment, writes a record, reads it back, and verifies it decrypts correctly. Useful as a sanity check that `@noy-db/hub` and your local Node version agree on Web Crypto.
 
 ```bash
-pnpm exec noy-db verify
+pnpm exec noy-db doctor crypto
 # ✔ noy-db integrity check passed (126ms)
 ```
 
 Exits non-zero if anything diverges.
 
-### `noy-db rotate [options]`
+### `noy-db user rotate [options]`
 
-Rotate the DEKs for one or more collections in a compartment. Generates fresh keys, re-encrypts every record with the new keys, and re-wraps the new keys into every user's keyring. Nobody is revoked — everyone keeps their current permissions with fresh key material.
+Rotate the DEKs for one or more collections in a vault. Generates fresh keys, re-encrypts every record with the new keys, and re-wraps the new keys into every user's keyring. Nobody is revoked — everyone keeps their current permissions with fresh key material.
 
 ```bash
 # Rotate every collection in the compartment
-pnpm exec noy-db rotate --dir ./data --compartment demo-co --user owner-alice
+pnpm exec noy-db user rotate --dir ./data --vault demo-co --user owner-alice
 
 # Rotate specific collections only
-pnpm exec noy-db rotate --dir ./data --compartment demo-co --user owner-alice \
+pnpm exec noy-db user rotate --dir ./data --vault demo-co --user owner-alice \
   --collections invoices,clients
 ```
 
@@ -221,7 +232,7 @@ Dump a compartment to a local file. The dump is a **verifiable backup**: it incl
 
 ```bash
 pnpm exec noy-db backup ./backups/demo-2026-04-07.json \
-  --dir ./data --compartment demo-co --user owner-alice
+  --dir ./data --vault demo-co --user owner-alice
 ```
 
 Target paths:

package/dist/bin/create.js

@@ -14,7 +14,12 @@ import pc from "picocolors";
 import { promises as fs } from "fs";
 import path from "path";
 import { fileURLToPath } from "url";
-var NOYDB_IN_VERSION = "0.8.0";
+var NOYDB_IN_VERSION = "0.10.0-pre.1";
+var ADAPTER_PACKAGES = {
+  browser: "@noy-db/to-browser-idb",
+  file: "@noy-db/to-file",
+  memory: "@noy-db/hub"
+};
 async function renderTemplate(src, dest, tokens) {
   const written = [];
   await walk(src, dest, "", tokens, written);
@@ -247,7 +252,7 @@ function isProxyArray(value) {
 
 // src/wizard/i18n/en.ts
 var en = {
-  wizardIntro: "A wizard for noy-db \u2014 None Of Your DataBase.\nGenerates a fresh Nuxt 4 + Pinia + encrypted-store starter.",
+  wizardIntro: "A wizard for noy-db \u2014 None Of Your DataBase.\nGenerates a fresh encrypted-store starter \u2014 minimal by default, Nuxt and more on request.",
   promptProjectName: "Project name",
   promptProjectNamePlaceholder: "my-noy-db-app",
   promptAdapter: "Storage adapter",
@@ -255,6 +260,7 @@ var en = {
   adapterFileLabel: "file \u2014 JSON files on disk (Electron / Tauri / USB workflows)",
   adapterMemoryLabel: "memory \u2014 no persistence (ideal for tests and demos)",
   promptSampleData: "Include sample invoice records?",
+  promptRecommended: "Use the recommended setup? (hub + browser storage, no framework \u2014 add more later with `noy-db add`)",
   freshNextStepsTitle: "Next steps",
   freshOutroDone: "\u2714 Done \u2014 happy encrypting!",
   augmentModeTitle: "Augment mode",
@@ -285,6 +291,7 @@ var th = {
   adapterFileLabel: "file \u2014 \u0E44\u0E1F\u0E25\u0E4C JSON \u0E1A\u0E19\u0E14\u0E34\u0E2A\u0E01\u0E4C (Electron / Tauri / USB)",
   adapterMemoryLabel: "memory \u2014 \u0E44\u0E21\u0E48\u0E1A\u0E31\u0E19\u0E17\u0E36\u0E01\u0E02\u0E49\u0E2D\u0E21\u0E39\u0E25 (\u0E40\u0E2B\u0E21\u0E32\u0E30\u0E2A\u0E33\u0E2B\u0E23\u0E31\u0E1A\u0E01\u0E32\u0E23\u0E17\u0E14\u0E2A\u0E2D\u0E1A\u0E41\u0E25\u0E30\u0E15\u0E31\u0E27\u0E2D\u0E22\u0E48\u0E32\u0E07)",
   promptSampleData: "\u0E40\u0E1E\u0E34\u0E48\u0E21\u0E02\u0E49\u0E2D\u0E21\u0E39\u0E25\u0E15\u0E31\u0E27\u0E2D\u0E22\u0E48\u0E32\u0E07\u0E43\u0E1A\u0E41\u0E08\u0E49\u0E07\u0E2B\u0E19\u0E35\u0E49\u0E2B\u0E23\u0E37\u0E2D\u0E44\u0E21\u0E48?",
+  promptRecommended: "\u0E43\u0E0A\u0E49\u0E01\u0E32\u0E23\u0E15\u0E31\u0E49\u0E07\u0E04\u0E48\u0E32\u0E17\u0E35\u0E48\u0E41\u0E19\u0E30\u0E19\u0E33\u0E44\u0E2B\u0E21? (hub + \u0E1E\u0E37\u0E49\u0E19\u0E17\u0E35\u0E48\u0E40\u0E01\u0E47\u0E1A\u0E02\u0E49\u0E2D\u0E21\u0E39\u0E25\u0E43\u0E19\u0E40\u0E1A\u0E23\u0E32\u0E27\u0E4C\u0E40\u0E0B\u0E2D\u0E23\u0E4C \u0E44\u0E21\u0E48\u0E21\u0E35\u0E40\u0E1F\u0E23\u0E21\u0E40\u0E27\u0E34\u0E23\u0E4C\u0E01 \u2014 \u0E40\u0E1E\u0E34\u0E48\u0E21\u0E17\u0E35\u0E2B\u0E25\u0E31\u0E07\u0E44\u0E14\u0E49\u0E14\u0E49\u0E27\u0E22 `noy-db add`)",
   freshNextStepsTitle: "\u0E02\u0E31\u0E49\u0E19\u0E15\u0E2D\u0E19\u0E16\u0E31\u0E14\u0E44\u0E1B",
   freshOutroDone: "\u2714 \u0E40\u0E2A\u0E23\u0E47\u0E08\u0E40\u0E23\u0E35\u0E22\u0E1A\u0E23\u0E49\u0E2D\u0E22 \u2014 \u0E02\u0E2D\u0E43\u0E2B\u0E49\u0E2A\u0E19\u0E38\u0E01\u0E01\u0E31\u0E1A\u0E01\u0E32\u0E23\u0E40\u0E02\u0E49\u0E32\u0E23\u0E2B\u0E31\u0E2A!",
   augmentModeTitle: "\u0E42\u0E2B\u0E21\u0E14\u0E40\u0E2A\u0E23\u0E34\u0E21\u0E42\u0E1B\u0E23\u0E40\u0E08\u0E01\u0E15\u0E4C\u0E40\u0E14\u0E34\u0E21",
@@ -392,15 +399,18 @@ async function runWizard(options = {}) {
 }
 async function runFreshMode(options, cwd, yes, msg) {
   const projectName = yes ? options.projectName ?? "my-noy-db-app" : await promptProjectName(options.projectName, msg);
-  const adapter = yes ? options.adapter ?? "browser" : await promptAdapter(options.adapter, msg);
-  const sampleData = yes ? options.sampleData ?? true : await promptSampleData(options.sampleData, msg);
-  const template = yes ? options.template ?? "nuxt-default" : await promptTemplate(options.template, msg);
-  const syncAdapter = yes ? options.syncAdapter ?? "none" : await promptSyncAdapter(options.syncAdapter, adapter, msg);
+  const explicit = options.template !== void 0 || options.adapter !== void 0 || options.sampleData !== void 0;
+  const recommended = yes || explicit ? false : await promptRecommended(msg);
+  const template = recommended ? "minimal" : yes ? options.template ?? "minimal" : await promptTemplate(options.template, msg);
+  const adapter = recommended ? "browser" : yes ? options.adapter ?? "browser" : await promptAdapter(options.adapter, msg);
+  const sampleData = recommended || template === "minimal" ? options.sampleData ?? false : yes ? options.sampleData ?? true : await promptSampleData(options.sampleData, msg);
+  const syncAdapter = options.syncAdapter ?? "none";
   const projectPath = path3.resolve(cwd, projectName);
   await assertWritableTarget(projectPath);
   const tokens = {
     PROJECT_NAME: projectName,
     ADAPTER: adapter,
+    ADAPTER_PACKAGE: ADAPTER_PACKAGES[adapter],
     DEVTOOLS: "true",
     SEED_INVOICES: sampleData ? JSON.stringify(DEFAULT_SEED, null, 2).replace(/\n/g, "\n  ") : "[]",
     NOYDB_VERSION: await ownVersion(),
@@ -412,16 +422,20 @@ async function runFreshMode(options, cwd, yes, msg) {
     projectPath,
     tokens
   );
+  const nextSteps = [
+    `${pc.bold("cd")} ${projectName}`,
+    `${pc.bold("pnpm install")}     ${pc.dim("(or npm/yarn/bun)")}`,
+    `${pc.bold("pnpm dev")}`
+  ].join("\n");
   if (!yes) {
-    p.note(
-      [
-        `${pc.bold("cd")} ${projectName}`,
-        `${pc.bold("pnpm install")}     ${pc.dim("(or npm/yarn/bun)")}`,
-        `${pc.bold("pnpm dev")}`
-      ].join("\n"),
-      msg.freshNextStepsTitle
-    );
+    p.note(nextSteps, msg.freshNextStepsTitle);
     p.outro(pc.green(msg.freshOutroDone));
+  } else {
+    process.stdout.write(`${msg.freshOutroDone}
+
+${msg.freshNextStepsTitle}
+${nextSteps}
+`);
   }
   return {
     kind: "fresh",
@@ -591,22 +605,8 @@ async function promptAdapter(initial, msg) {
   }
   return result;
 }
-async function promptSyncAdapter(initial, primary, _msg) {
-  if (initial !== void 0) return initial;
-  const choices = ["none", "memory", "file", "browser"].filter(
-    (x) => x !== primary
-  );
-  const labels = {
-    none: "No sync \u2014 local only",
-    memory: "In-memory (testing / CI)",
-    file: "JSON files (USB / shared drive)",
-    browser: "IndexedDB (other tabs / PWAs)"
-  };
-  const result = await p.select({
-    message: "Add a sync target?",
-    options: choices.map((value) => ({ value, label: labels[value] })),
-    initialValue: "none"
-  });
+async function promptRecommended(msg) {
+  const result = await p.confirm({ message: msg.promptRecommended, initialValue: true });
   if (p.isCancel(result)) {
     process.exit(1);
   }
@@ -617,10 +617,15 @@ async function promptTemplate(initial, _msg) {
   const result = await p.select({
     message: "Pick a starter template",
     options: [
+      {
+        value: "minimal",
+        label: "Minimal \u2014 Vite + TypeScript, one file",
+        hint: "hub + browser storage, put/get (recommended)"
+      },
       {
         value: "nuxt-default",
         label: "Nuxt 4 + Pinia",
-        hint: "SSR + file-based routing (recommended default)"
+        hint: "SSR + file-based routing"
       },
       {
         value: "vite-vue",
@@ -638,7 +643,7 @@ async function promptTemplate(initial, _msg) {
         hint: "Desktop app with to-file adapter \u2014 USB workflow"
       }
     ],
-    initialValue: "nuxt-default"
+    initialValue: "minimal"
   });
   if (p.isCancel(result)) {
     process.exit(1);
@@ -673,6 +678,7 @@ async function assertWritableTarget(target) {
 
 // src/wizard/types.ts
 var WIZARD_TEMPLATES = [
+  "minimal",
   "nuxt-default",
   "vanilla",
   "vite-vue",
@@ -773,7 +779,7 @@ The wizard auto-detects whether cwd is an existing Nuxt 4 project:
 Options:
   -y, --yes               Skip prompts; use defaults for missing values
       --adapter <name>    Adapter: browser (default) | file | memory
-      --template <name>   Template: nuxt-default (default) | vite-vue | vanilla | electron
+      --template <name>   Template: minimal (default) | nuxt-default | vite-vue | vanilla | electron
       --sync <name>       Sync target (multi-backend):
                           none (default) | memory | file | browser
       --no-sample-data    (fresh mode) Skip the seed invoice records
@@ -788,6 +794,8 @@ Examples:
   # Fresh project in a new directory
   npm create noy-db my-app
   npm create noy-db my-app --yes --adapter file
+  npm create noy-db my-app --yes                      # minimal: hub + browser storage
+  npm create noy-db my-app --yes --template nuxt-default
   npm create noy-db my-app --yes --template vite-vue
   npm create noy-db my-app --yes --template vanilla