@tokenoftrust/cli 1.4.0 → 1.5.0

package/README.md

@@ -19,6 +19,11 @@ install, no hand-provisioned AWS credentials. (Docker remains available as a
 fallback — `tot dev --docker` — or automatically if the native artifact can't
 be fetched.)
 
+For Storefront Private App contracts, examples, and LLM-ready developer material, start at
+[Storefront Devkit — Apps / Private](https://github.com/tokenoftrust/storefront-devkit/tree/main/apps/private).
+The `tot app` commands use the CLI's self-contained helper; they do not require a separately
+published npm SDK.
+
 ## Commands
 
 | Command | Status | What it does |

package/bin/tot.mjs

@@ -2,27 +2,9 @@
 /**
  * `tot` — the Token of Trust developer CLI.
  *
- * One command a developer learns to go from an invite to a running store:
- *
- *   tot start                 invite → running store in one command      ← built (orchestrates the below, value-first)
- *   tot login                 sign in to Token of Trust (OAuth)          ← built (MCP OAuth PKCE loopback; caches ~/.tot/credentials.json)
- *   tot logout                sign out (clear the cached session)        ← built (deletes ~/.tot/credentials.json; local-only, no server revoke)
- *   tot whoami                who you're signed in as                    ← built
- *   tot link                  link your identity to the ToT broker (resolve store scope)  ← built
- *   tot grants                capability/tier/expiry per store you can act on  ← built (introspection diagnostics)
- *   tot clone [<tenant>]      clone a store you can build on            ← built
- *   tot validate              lint your store before you submit         ← built
- *   tot dev                   run your store locally with save→reload   ← built (monorepo: host astro; standalone: runs the published runner image)
- *   tot preview               push your store to a reviewable preview   ← built (validate + push preview ref; MCP preview_status read-back). `submit`/`deploy` are teaching aliases.
- *   tot ship                  publish the current green aggregate live  ← built (GET/POST /api/changes/ship → b09 orchestrator; exact plan + y/N confirm; waits for VERIFIED live truth)
- *   tot accept / tot merge    queue a PR into the preview aggregate      ← built (b08: plan + y/N confirm → POST /api/changes/integrate = b07 queue enqueue; NO merge-to-main, NO go-live; refuses non-TTY without --yes)
- *   tot rollback [<version>]  instant re-point to a prior live version  ← built (u3 promotion_status/promotion_rollback seam; diff + y/N confirm; refuses non-TTY / ineligible)
- *   tot pr                    list / view / close your candidate PRs    ← built (candidate_status/candidate_close; gh-pr-shaped)
- *   tot doctor                check this machine is ready
- *   tot ideas                 copy-paste AI prompts that reliably wow
- *   tot feedback              send a note to ToT + your recent CLI activity  ← built (activity-log.mjs → feedback_submit MCP tool)
- *   tot app scaffold/dev      build + locally exercise a Private App        ← built (offline; see src/commands/app/)
- *   tot help                  this help
+ * One command a developer learns to go from an invite to a running store. The
+ * user-facing command list is the single source of truth in `COMMANDS` below;
+ * `usage()` renders it, so add new commands there — never in a second list.
  *
  * Context-aware (see src/context.mjs): the same `tot` does the right thing from
  * inside the storefront monorepo, from inside a standalone tenant checkout, or
@@ -37,6 +19,7 @@ import { readFileSync } from "node:fs";
 import { detectContext } from "../src/context.mjs";
 import { printError } from "../src/errors.mjs";
 import { recordActivity, redactArgs } from "../src/activity-log.mjs";
+import { emitActivity, capRendered } from "../src/activity.mjs";
 import { maybeNotifyUpdate } from "../src/update-check.mjs";
 
 const BUILD_ORDER = ["clone", "validate", "dev", "preview"];
@@ -50,33 +33,47 @@ const VERSION = (() => {
   }
 })();
 
+// Single source of truth for the user-facing command list. `usage()` renders
+// it and the file header points here; keep new commands in this one array so the
+// help output can't drift from a second hand-maintained copy. `invocation` is the
+// text after `tot ` (including any argument hint); `blurb` is the one-line help.
+const COMMANDS = [
+  { invocation: "start", blurb: "invite → running store in one command (start here)" },
+  { invocation: "login", blurb: "sign in to Token of Trust" },
+  { invocation: "logout", blurb: "sign out (clear the cached session)" },
+  { invocation: "whoami", blurb: "show who you're signed in as" },
+  { invocation: "link", blurb: "link your identity so your stores resolve" },
+  { invocation: "grants", blurb: "capability/tier/expiry per store you can act on" },
+  { invocation: "clone [<tenant>]", blurb: "clone a store you can build on" },
+  { invocation: "validate", blurb: "lint your store before you submit" },
+  { invocation: "dev", blurb: "run your store locally with save→reload" },
+  { invocation: "preview", blurb: "push your store to a reviewable preview" },
+  { invocation: "ship", blurb: "publish the tenant's current green aggregate live (plan → confirm → ship)" },
+  { invocation: "accept / tot merge", blurb: "queue a PR into the preview aggregate — operator verb, no go-live (plan → confirm → integrate)" },
+  { invocation: "sync", blurb: "fetch `preview` and merge it into your local branch (accept-conflict recovery)" },
+  { invocation: "rollback [<version>]", blurb: "instant re-point to a prior live version (list → confirm → rollback)" },
+  { invocation: "revert --preview <PR|sha>", blurb: "remove already-integrated content from the preview aggregate via a new revert commit — no force-reset (plan → confirm → revert)" },
+  { invocation: "hotfix --pr <N>", blurb: "OWNER-ONLY exception: release an urgent fix from main to live, bypassing unshipped preview work (plan → confirm → release → auto forward-integrate)", },
+  { invocation: "go-live", blurb: "cut the apex domain over to the storefront (readiness → confirm → cutover)" },
+  { invocation: "pr", blurb: "list / view / close your candidate PRs" },
+  { invocation: "branches", blurb: "full branch-cleanup report — every branch, any PR state, cleanup eligibility" },
+  { invocation: "cleanup", blurb: "owner-confirmed branch GC (--dry-run to classify only; deletes terminal branches only)" },
+  { invocation: "doctor", blurb: "check this machine is ready" },
+  { invocation: "ideas", blurb: "copy-paste AI prompts that reliably wow" },
+  { invocation: 'feedback "<msg>"', blurb: "send feedback to Token of Trust (attaches recent activity)" },
+  { invocation: "app scaffold <name>", blurb: "scaffold a Storefront Private App" },
+  { invocation: "app dev ...", blurb: "local, offline Private App webhook/manifest/JWT harness" },
+  { invocation: "help", blurb: "show this help" },
+  { invocation: "--version", blurb: "print the CLI version" },
+];
+
 function usage() {
+  const col = Math.max(...COMMANDS.map((c) => `tot ${c.invocation}`.length)) + 2;
+  const lines = COMMANDS.map((c) => `  ${`tot ${c.invocation}`.padEnd(col)}${c.blurb}`).join("\n");
   console.log(`
 tot — Token of Trust developer CLI
 
-  tot start                 invite → running store in one command (start here)
-  tot login                 sign in to Token of Trust
-  tot logout                sign out (clear the cached session)
-  tot whoami                show who you're signed in as
-  tot link                  link your identity so your stores resolve
-  tot grants                capability/tier/expiry per store you can act on
-  tot clone [<tenant>]      clone a store you can build on
-  tot validate              lint your store before you submit
-  tot dev                   run your store locally with save→reload
-  tot preview               push your store to a reviewable preview
-  tot ship                  publish the tenant's current green aggregate live (plan → confirm → ship)
-  tot accept / tot merge    queue a PR into the preview aggregate — operator verb, no go-live (plan → confirm → integrate)
-  tot rollback [<version>]  instant re-point to a prior live version (list → confirm → rollback)
-  tot retire                evict a candidate PR's preview to reclaim space — operator verb, rebuildable (plan → confirm → evict)
-  tot go-live               cut the apex domain over to the storefront (readiness → confirm → cutover)
-  tot pr                    list / view / close your candidate PRs
-  tot doctor                check this machine is ready
-  tot ideas                 copy-paste AI prompts that reliably wow
-  tot feedback "<msg>"      send feedback to Token of Trust (attaches recent activity)
-  tot app scaffold <name>   scaffold a Storefront Private App
-  tot app dev ...           local, offline Private App webhook/manifest/JWT harness
-  tot help                  show this help
-  tot --version             print the CLI version
+${lines}
 
 Run \`tot <command> --help\` for command-specific options.
 `);
@@ -108,12 +105,12 @@ async function dispatch(cmd, rest, ctx) {
 
   if (cmd === "logout") {
     const { run } = await import("../src/commands/logout.mjs");
-    return run(rest, ctx);
+    return /** @type {any} */ (run)(rest, ctx);
   }
 
   if (cmd === "feedback") {
     const { run } = await import("../src/commands/feedback.mjs");
-    return run(rest, ctx);
+    return /** @type {any} */ (run)(rest, ctx);
   }
 
   if (cmd === "whoami") {
@@ -146,6 +143,15 @@ async function dispatch(cmd, rest, ctx) {
     return run(rest, ctx);
   }
 
+  // Plumbing, not a developer-facing verb (like git's own credential helpers,
+  // never listed in `git help`) — `tot clone` configures it as this checkout's
+  // `credential.helper`, and git alone invokes it (get/store/erase) on every
+  // fetch/push. See src/commands/git-credential.mjs's header.
+  if (cmd === "git-credential") {
+    const { run } = await import("../src/commands/git-credential.mjs");
+    return run(rest, ctx);
+  }
+
   if (cmd === "validate") {
     const { run } = await import("../src/commands/validate.mjs");
     return run(rest, ctx);
@@ -174,26 +180,49 @@ async function dispatch(cmd, rest, ctx) {
     return run(rest, ctx);
   }
 
-  // `accept` queue-integrates a PR into the protected `preview` aggregate (b08) —
+  // `accept` queue-integrates a PR into the protected `preview` aggregate —
   // NO merge-to-main, NO go-live; going live is `tot ship`, which publishes the
-  // whole current GREEN AGGREGATE (b10). Backed by POST /api/changes/integrate
-  // (b07's TenantIntegrationQueue.enqueue); see accept.mjs's header. `merge` is a
+  // whole current GREEN AGGREGATE. Backed by POST /api/changes/integrate
+  // (TenantIntegrationQueue.enqueue); see accept.mjs's header. `merge` is a
   // first-class alias, not a teaching nudge: both dispatch straight to the same command.
   if (cmd === "accept" || cmd === "merge") {
     const { run } = await import("../src/commands/accept.mjs");
     return run(rest, ctx);
   }
 
+  // `sync` is the common accept-conflict recovery path: fetches the
+  // protected `preview` branch and merges it into the developer's local branch so
+  // they can resolve locally, then re-`tot preview`. Purely local — no push, no
+  // MCP call, never touches the shared `preview`/`main` refs themselves. See
+  // sync.mjs's header for the full contract.
+  if (cmd === "sync") {
+    const { run } = await import("../src/commands/sync.mjs");
+    return run(rest, ctx);
+  }
+
   if (cmd === "rollback") {
     const { run } = await import("../src/commands/rollback.mjs");
     return run(rest, ctx);
   }
 
-  // `retire` evicts a candidate PR's hosted preview to reclaim space (unit U7) —
-  // a DISTINCT operator verb from `accept`/reject: retire touches no change
-  // lifecycle and is reversible-by-rebuild (`tot preview build`). See retire.mjs.
-  if (cmd === "retire") {
-    const { run } = await import("../src/commands/retire.mjs");
+  // `revert --preview <PR|integration-sha>` removes already-integrated content from
+  // the protected `preview` aggregate via a NEW auditable revert commit — NO
+  // force-reset, NO touch to main/live. Backed by POST /api/changes/revert
+  // (TenantIntegrationQueue.enqueueRevert). To undo something already LIVE, that's
+  // `tot rollback`, not this. See revert.mjs's header.
+  if (cmd === "revert") {
+    const { run } = await import("../src/commands/revert.mjs");
+    return run(rest, ctx);
+  }
+
+  // `hotfix --pr <N>` is the OWNER-ONLY EXCEPTION lane: release an urgent fix
+  // from `main` to live while `preview` still holds other unshipped work, EXCLUDING
+  // that unshipped preview head, then automatically forward-integrate main → preview
+  // and re-validate. It is DELIBERATELY a distinct verb — never a `--base main` flag
+  // on `tot ship` (which publishes the whole green preview aggregate). Backed by
+  // GET/POST /api/changes/hotfix → HotfixOrchestrator. See hotfix.mjs's header.
+  if (cmd === "hotfix") {
+    const { run } = await import("../src/commands/hotfix.mjs");
     return run(rest, ctx);
   }
 
@@ -207,6 +236,23 @@ async function dispatch(cmd, rest, ctx) {
     return run(rest, ctx);
   }
 
+  // `branches` is the FULL branch-cleanup report (every branch, any PR state) —
+  // distinct from `tot pr list`, which only shows OPEN PRs. Read-only;
+  // always safe to run, and the report `tot cleanup` reuses before deleting anything.
+  if (cmd === "branches") {
+    const { run } = await import("../src/commands/branches.mjs");
+    return run(rest, ctx);
+  }
+
+  // `cleanup` is owner-confirmed BRANCH GC — an irreversible git-ref
+  // delete for terminal candidates. `--dry-run` classifies and prints; it never deletes. Age alone
+  // never makes a branch eligible; main/preview are always kept; orphans are
+  // quarantined, never auto-deleted. See cleanup.mjs's header.
+  if (cmd === "cleanup") {
+    const { run } = await import("../src/commands/cleanup.mjs");
+    return run(rest, ctx);
+  }
+
   if (cmd === "app") {
     const { run } = await import("../src/commands/app/index.mjs");
     return run(rest, ctx);
@@ -238,12 +284,39 @@ async function dispatch(cmd, rest, ctx) {
   return 2;
 }
 
+/**
+ * The safe `subcommand` value for a command's activity event. Only the fixed
+ * sub-dispatcher verbs (e.g. `app scaffold` / `app dev`) are surfaced — an
+ * arbitrary positional (a tenant name, a path, a code) is NEVER used, so the
+ * activity `subcommand` field can't carry PII even before redaction. Returns
+ * undefined for every command without a fixed subcommand vocabulary.
+ */
+function safeSubcommand(cmd, rest) {
+  if (cmd === "app") {
+    const sub = rest.find((t) => t && !t.startsWith("-"));
+    if (sub === "scaffold" || sub === "dev") return sub;
+  }
+  return undefined;
+}
+
 async function main() {
   const [cmd, ...rest] = process.argv.slice(2);
   const ctx = detectContext();
   const startedAt = Date.now();
+  const command = cmd || "(none)";
+  const subcommand = safeSubcommand(cmd, rest);
   let code = 0;
   let errMsg = null;
+
+  // Emit `cli.command.invoked` on start — best-effort, a SILENT no-op without a
+  // hosted-bridge credential (never a network call / never blocks). Fired without
+  // await so it adds no latency to the command; settled alongside the result below.
+  const invokedEmit = emitActivity({
+    action: "cli.command.invoked",
+    outcome: { status: "invoked" },
+    payload: { args: { command, ...(subcommand ? { subcommand } : {}), cliVersion: VERSION, node: process.version } },
+  });
+
   try {
     code = await dispatch(cmd, rest, ctx);
     return code;
@@ -251,17 +324,35 @@ async function main() {
     errMsg = e?.message || String(e);
     throw e;
   } finally {
+    const exitCode = errMsg ? 1 : (code ?? 0);
+    const durationMs = Date.now() - startedAt;
     // Best-effort activity breadcrumb (never throws, never blocks). `feedback`'s own
     // free-text message is omitted — it's user-typed and belongs only in the report.
     recordActivity({
       ts: new Date().toISOString(),
       v: VERSION,
-      cmd: cmd || "(none)",
+      cmd: command,
       args: cmd === "feedback" ? ["«omitted»"] : redactArgs(rest),
-      code: errMsg ? 1 : (code ?? 0),
-      ms: Date.now() - startedAt,
+      code: exitCode,
+      ms: durationMs,
       ...(errMsg ? { err: String(errMsg).slice(0, 200) } : {}),
     });
+    // Emit `cli.command.result` (exit code + duration + a bounded/redacted
+    // rendered field). The house-style error text is capped + run through the JS
+    // redaction mirror; per the activity catalog the `cli.*` rendered lane is empty-
+    // allowlisted, so it's DROPPED by design (the safe default for a high-volume
+    // action) — the emit path still exercises the mirror. Bounded-await here (with
+    // the invoked emit) so a live bridge flushes before the process exits; a no-op
+    // when there's no credential.
+    const resultEmit = emitActivity({
+      action: "cli.command.result",
+      outcome: { status: errMsg ? "failed" : "succeeded", durationMs },
+      payload: {
+        args: { command, ...(subcommand ? { subcommand } : {}), cliVersion: VERSION, exitCode, durationMs },
+        ...(errMsg ? { rendered: { output: capRendered(errMsg) } } : {}),
+      },
+    });
+    await Promise.allSettled([invokedEmit, resultEmit]);
     // Nudge if a newer/unsupported version exists (drawn from cache — instant),
     // and kick a detached registry refresh if stale. Never throws, never blocks.
     maybeNotifyUpdate(VERSION);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tokenoftrust/cli",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "Token of Trust developer CLI — clone a tenant store, run it locally with save→reload, and submit it for preview. Installs the `tot` command.",
   "license": "Apache-2.0",
   "author": "Token of Trust",
@@ -36,7 +36,12 @@
     "access": "public",
     "registry": "https://registry.npmjs.org"
   },
+  "devDependencies": {
+    "@types/node": "^20.16.0",
+    "typescript": "^5.6.3"
+  },
   "scripts": {
+    "typecheck": "tsc --noEmit",
     "test": "node --test",
     "prepublishOnly": "node ../../scripts/build/check-cli-clean.mjs ."
   }