@opennous/cli 0.5.0 → 0.7.0

package/README.md

@@ -1,21 +1,30 @@
 # @opennous/cli
 
-Nous CLI — install Nous event tracking into your app, plus terminal access to the Context API.
+Nous CLI — set Nous up, connect it to your coding agent, and read the Context API from your terminal.
 
-## Quick start
+## Get started
 
 ```bash
-# in your project root
-npx -y @opennous/cli@latest install
+curl -fsSL https://get.opennous.cloud | sh
 ```
 
-`nous install` detects your stack (Next.js, Node, Python), writes a small `nous.js` (or `nous.py`) module with three helpers, and updates your `.env`:
+That installs the CLI and runs `nous init`, which signs you in (creating your account if you don't have one), registers the Nous MCP server with the agent on your machine, and hands off. Then tell your agent *"set up my Nous workspace"* — it reads your project, finds your ICP (or drafts one), and syncs it.
+
+Prefer to run it yourself:
+
+```bash
+npx -y @opennous/cli@latest init
+```
+
+## Event tracking
+
+`nous track init` detects your stack (Next.js, Node, Python), writes a small `nous.js` (or `nous.py`) module with three helpers, and updates your `.env`:
 
 - **`trackSignup({email, ...})`** — fires `interaction.signed_up` + initial `state.stage`
 - **`handleStripeEvent(event, {customerEmail})`** — fires `interaction.subscription_started / updated / canceled` and flips `state.stage` (Customer / Churned)
 - **`track(focus, property, value)`** — escape hatch for any other event
 
-The generated module is plain code you own. Read it, edit it, or delete it.
+The generated module is plain code you own. Read it, edit it, or delete it. (This was `nous install`; that name still works but is deprecated.)
 
 ## Other commands
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opennous/cli",
-  "version": "0.5.0",
-  "description": "Nous CLI — install Nous event tracking into your app, plus terminal access to the Context API",
+  "version": "0.7.0",
+  "description": "Nous CLI — set up Nous, connect it to your coding agent, and read the Context API from your terminal",
   "type": "module",
   "bin": {
     "nous": "src/index.js"

package/src/index.js

@@ -10,10 +10,16 @@ import { readFileSync, writeFileSync, existsSync, mkdirSync, appendFileSync } fr
 import { homedir } from "os";
 import { join, resolve } from "path";
 import { createInterface } from "readline";
-import { spawn } from "child_process";
+import { spawn, spawnSync } from "child_process";
 
 const sleep = (ms) => new Promise((r) => setTimeout(r, ms));
 
+// Recede, don't decorate. Secondary text in a terminal should be readable and
+// quiet — and it must degrade to plain text when the output is piped, because a
+// CI log full of escape codes is worse than no colour at all.
+const COLOR = process.stdout.isTTY && !process.env.NO_COLOR;
+const dim = (t) => (COLOR ? `\x1b[2m${t}\x1b[0m` : t);
+
 // Best-effort open the user's browser; if it fails they have the printed URL.
 function openBrowser(url) {
   const cmd = process.platform === "darwin" ? "open"
@@ -293,8 +299,17 @@ const NEXT_STEPS = {
   3. Call handle_stripe_event(event, customer_email) inside your Stripe webhook view.`,
 };
 
-program
-  .command("install")
+// `nous track init` — drop event tracking into the user's app. This used to be
+// `nous install`, which collided head-on with the front-door meaning of "install":
+// people typed `nous install` expecting to set Nous up and got an app-instrumentation
+// scaffolder instead. The front door is now `nous init`. `install` stays as a hidden
+// deprecated alias so nobody's script breaks, and it prints where the command went.
+const trackCmd = program
+  .command("track")
+  .description("Instrument your app to send events to Nous");
+
+function defineTrackInit(cmd) {
+  return cmd
   .description("Drop Nous event tracking (signups + Stripe lifecycle) into the current project")
   .option("--dir <path>", "Target project directory (default: cwd)", process.cwd())
   .option("--lang <stack>", "Force language/stack: next | node-esm | node-cjs | python")
@@ -353,6 +368,17 @@ program
     console.log(`\nDetected stack: ${stack}`);
     console.log(`\n${NEXT_STEPS[stack] || NEXT_STEPS["node-esm"]}\n`);
   });
+}
+
+// The real command: `nous track init`.
+defineTrackInit(trackCmd.command("init"));
+
+// Deprecated alias: `nous install`. Kept so existing scripts don't break; it does the
+// same thing but says where it moved, because "install" is now `nous init`.
+defineTrackInit(program.command("install"))
+  .hook("preAction", () => {
+    console.error(dim("note: `nous install` is now `nous track init`. Run `nous init` to set up Nous itself.\n"));
+  });
 
 // ---------------------------------------------------------------------------
 // nous auth
@@ -383,9 +409,20 @@ program
         if (key) {
           console.log(`Logged in\nAPI URL: ${url}\nKey: ${key.slice(0, 8)}...`);
         } else {
-          console.log("Not logged in. Run: nous auth login --key <your-key>");
+          console.log("Not logged in. Run: npx @opennous/cli login");
         }
       })
+  )
+  .addCommand(
+    new Command("logout")
+      .description("Sign out — remove the saved API key")
+      .action(() => {
+        const cfg = readConfig();
+        if (!cfg.apiKey) { console.log("Not signed in."); return; }
+        delete cfg.apiKey;
+        writeConfig(cfg);
+        console.log("✓ Signed out — removed the saved API key from ~/.nous/config.json");
+      })
   );
 
 // ---------------------------------------------------------------------------
@@ -585,6 +622,118 @@ program
     });
   });
 
+// ---------------------------------------------------------------------------
+// nous audit — is this graph actually sound?
+//
+// The command that answers the only question a technical team has before trusting
+// data they didn't collect themselves. It is deliberately a COMMAND and not a
+// dashboard: a dashboard makes a claim about our own product and asks you to
+// believe it; a command runs against your data, in your terminal, and returns an
+// exit code. One of those can fail a build.
+// ---------------------------------------------------------------------------
+program
+  .command("audit")
+  .description("Audit your GTM data — what's broken, what's unsure, and what to do about it")
+  .option("--check <name>", "One check only: arriving, resolved, evidenced, current, reachable")
+  .option("--list", "List the records behind each finding")
+  .option("--fail-under <n>", "Exit 1 if health is below this percentage — for CI")
+  .option("--fix", "Show the repairs that can be made safely, without making them")
+  .option("--apply", "Actually make them (use with --fix)")
+  .option("--json", "Print the raw JSON response")
+  .action(async ({ check, list, failUnder, fix, apply, json }) => {
+    const api = apiClient();
+
+    // ── nous audit --fix ──
+    //
+    // Only the repairs that need no judgment: records sharing an email or a
+    // LinkedIn profile are the same human by definition. Everything else the audit
+    // finds needs a decision, a browser, or you — and a --fix that quietly did
+    // those too would be one nobody could trust.
+    if (fix) {
+      const out = await api.post("/v2/audit/fix", { apply: !!apply });
+      if (json) { console.log(JSON.stringify(out, null, 2)); return; }
+
+      if (out.dry_run) {
+        if (!out.would_merge) {
+          console.log("\n  Nothing to repair automatically.\n");
+          return;
+        }
+        console.log(`\n  ${out.would_merge} ${out.would_merge === 1 ? "merge" : "merges"} can be made safely:\n`);
+        for (const m of out.merges) {
+          console.log(`    · ${m.who ?? m.keep}  ${dim("— " + m.why)}`);
+        }
+        console.log(dim("\n  Nothing changed. Re-run with --fix --apply to make them.\n"));
+        return;
+      }
+
+      console.log(`\n  Merged ${out.merged}.${out.failed ? `  ${out.failed} failed.` : ""}\n`);
+      for (const f of out.failures ?? []) console.error(`    ✗ ${f.who ?? f.keep}: ${f.error}`);
+      if (out.failed) process.exit(1);
+      return;
+    }
+
+    const data = await api.get("/v2/audit", check ? { check } : {});
+
+    if (json) {
+      console.log(JSON.stringify(data, null, 2));
+    } else {
+      const checks = check ? [data.check] : data.checks;
+      const findings = data.findings ?? [];
+
+      console.log("");
+      for (const c of checks) {
+        const pct = String(c.pct).padStart(4);
+        const mark = c.pct === 100 ? "\u2713" : "\u2717";
+        console.log(`  ${pct}%  ${c.label.toUpperCase().padEnd(11)} ${c.summary}  ${mark}`);
+        // What we deliberately did not count. An audit cannot itself be a black box.
+        if (c.note) console.log(`         ${dim(c.note)}`);
+      }
+
+      if (!findings.length) {
+        console.log("\n  Nothing to fix.\n");
+      } else {
+        console.log("");
+        for (const f of findings) {
+          console.log(`  [${f.severity.toUpperCase()}] ${f.title}`);
+          console.log(`         ${dim(f.detail)}`);
+          // Who can fix it, said plainly. Pretending we can re-authorise someone's
+          // Gmail is how a tool loses trust the first time it fails to.
+          const by = f.fixable_by === "human"
+            ? "needs you"
+            : f.fixable_by === "agent_with_confirmation"
+              ? "the agent, once you confirm"
+              : "the agent";
+          console.log(`         \u2192 ${f.fix}  (${by})`);
+
+          if (list && f.subjects?.length) {
+            for (const sub of f.subjects.slice(0, 20)) {
+              const line = sub.who
+                ? (Array.isArray(sub.who) ? sub.who.join("  \u2194  ") : sub.who)
+                : Object.entries(sub).map(([k, v]) => `${k}=${v}`).join(" ");
+              console.log(`           \u00b7 ${line}${sub.why ? dim("  — " + sub.why) : ""}`);
+            }
+            if (f.subjects.length > 20) {
+              console.log(`           \u00b7 ${dim(`and ${f.subjects.length - 20} more`)}`);
+            }
+          }
+          console.log("");
+        }
+        if (!list) console.log(dim("  Add --list to see the records behind each finding.\n"));
+      }
+    }
+
+    // The reason this is a command. An exit code can stop a deploy; a dashboard
+    // cannot. You would have known about a dead connector on day one, not day 48.
+    const health = check ? data.check.pct : data.health;
+    if (failUnder !== undefined) {
+      const floor = Number(failUnder);
+      if (health < floor) {
+        console.error(`\n  FAIL: health ${health}% is below the threshold of ${floor}%\n`);
+        process.exit(1);
+      }
+    }
+  });
+
 // ---------------------------------------------------------------------------
 // nous verify <focus> <property> — re-check a claim before acting on it
 // ---------------------------------------------------------------------------
@@ -721,20 +870,162 @@ program
     console.log("Your Nous tools are ready — try `get_workspace_status` in your agent.");
   });
 
-// nous init — the one-line "get started": sign in, then connect to your agent.
-// This is the command the marketing site points to (`npx @opennous/cli init`).
+// ---------------------------------------------------------------------------
+// MCP registration — connect Nous to whatever agent is on this machine.
+//
+// We deliberately DO NOT use the Claude Code plugin/marketplace here. Two commands
+// (`/plugin marketplace add`, `/plugin install`), Claude-Code-only, with a marketplace
+// standing between a new user and the product — it's too much for a first run. The MCP
+// server is the whole integration, and `claude mcp add` registers it in one line.
+//
+// The MCP resolves its key from ~/.nous/config.json on every call, so we never bake the
+// key into any of these configs — sign-in already wrote it there.
+// ---------------------------------------------------------------------------
+
+const MCP_CMD = "npx";
+const MCP_ARGS = ["-y", "@opennous/mcp"];
+
+/** Is the `claude` CLI on PATH? Then registration is one command and needs no file. */
+function hasClaudeCli() {
+  try {
+    const r = spawnSync("claude", ["--version"], { stdio: "ignore" });
+    return r.status === 0;
+  } catch { return false; }
+}
+
+/** Merge a `nous` server into a JSON MCP config file (Claude Code / Cursor shape). */
+function writeJsonMcp(path, apiUrl) {
+  let cfg = {};
+  if (existsSync(path)) {
+    try { cfg = JSON.parse(readFileSync(path, "utf8")); } catch { cfg = {}; }
+  }
+  cfg.mcpServers = cfg.mcpServers || {};
+  cfg.mcpServers.nous = {
+    command: MCP_CMD,
+    args: MCP_ARGS,
+    // Only pin a non-default API URL (self-host). Cloud reads the key from the config file.
+    ...(apiUrl && apiUrl !== "https://api.opennous.cloud" ? { env: { NOUS_API_URL: apiUrl } } : {}),
+  };
+  const dir = path.slice(0, path.lastIndexOf("/"));
+  if (dir && !existsSync(dir)) mkdirSync(dir, { recursive: true });
+  writeFileSync(path, JSON.stringify(cfg, null, 2) + "\n");
+}
+
+/**
+ * Register the MCP server with the agent on this machine. Returns a short line describing
+ * what happened, for the caller to print.
+ *
+ * Order of preference:
+ *   1. `claude mcp add` if the Claude CLI is here — one command, no file to manage.
+ *   2. Write ./.mcp.json in the current project (Claude Code and most clients read it).
+ * We never fail the flow on this — a printed fallback is better than an abort.
+ */
+function registerMcp(apiUrl) {
+  if (hasClaudeCli()) {
+    const args = ["mcp", "add", "nous", "--scope", "user"];
+    if (apiUrl && apiUrl !== "https://api.opennous.cloud") args.push("-e", `NOUS_API_URL=${apiUrl}`);
+    args.push("--", MCP_CMD, ...MCP_ARGS);
+    const r = spawnSync("claude", args, { stdio: "ignore" });
+    if (r.status === 0) return "Registered Nous with Claude Code (claude mcp add).";
+    // add fails if a server named nous already exists — that's a success for our purposes.
+    return "Nous is already registered with Claude Code.";
+  }
+  const path = join(process.cwd(), ".mcp.json");
+  writeJsonMcp(path, apiUrl);
+  return `Wrote ${path} — your agent will pick up Nous from it.`;
+}
+
+// nous init — the one-line "get started": sign in, register the MCP, hand off to the agent.
+// This is the command the install script and the marketing site point to.
 program
   .command("init")
-  .description("Get started — sign in, then connect Nous to your agent")
+  .description("Get started — sign in and connect Nous to your agent")
   .option("--url <url>", "API base URL (default: https://api.opennous.cloud)")
-  .action(async ({ url }) => {
+  .option("--no-register", "Skip registering the MCP server (just sign in)")
+  .action(async ({ url, register }) => {
     await browserLogin(url);
-    console.log("\nNow add Nous to Claude Code:\n");
-    console.log("  /plugin marketplace add NousC/nous");
-    console.log("  /plugin install nous@nous-plugins\n");
-    console.log('Then tell your agent: "set me up" — it onboards your workspace and builds your playbook.');
-    console.log("\nDocs: https://docs.opennous.cloud/mcp/introduction");
+
+    const apiUrl = url || readConfig().apiUrl || "https://api.opennous.cloud";
+    if (register !== false) {
+      try {
+        console.log(`\n${registerMcp(apiUrl)}`);
+      } catch (e) {
+        // Never let registration take down sign-in — print the manual line instead.
+        console.log("\nCouldn't register the MCP automatically. Add it with:");
+        console.log(`  claude mcp add nous -- ${MCP_CMD} ${MCP_ARGS.join(" ")}`);
+      }
+    }
+
+    console.log('\nYou\'re set. Tell your agent: "set up my Nous workspace" — it reads your');
+    console.log("project, finds your ICP (or drafts one), and syncs it. That's onboarding.\n");
+    console.log(dim("Docs: https://docs.opennous.cloud/mcp/introduction"));
+  });
+
+// nous pull — write the Vault into ./context/*.md and hand authorship to the repo.
+//
+// The bridge for the Google road. A user who set up in the browser has a Vault whose author
+// is Nous (source 'nous', no file). The day they open a repo and connect an agent, that
+// arrangement is backwards: they now live in files, and the Vault should mirror the files,
+// not the other way round. `pull` flips it — it writes each context doc to disk and re-syncs
+// it WITH its path, which sets source='claude_code'. From then on their repo is the author,
+// exactly as if they'd started on the agent road.
+//
+// It only touches slots that exist, and by default won't clobber a file that's already there
+// (the repo, once it's the author, wins) unless you pass --force.
+const PULL_KINDS = { icp: "icp.md", positioning: "positioning.md", voice: "voice.md", outreach: "messaging.md" };
+
+program
+  .command("pull")
+  .description("Write your Nous context docs into ./context and let your repo own them")
+  .option("--dir <path>", "Where to write the context/ folder (default: cwd)", process.cwd())
+  .option("--force", "Overwrite files that already exist", false)
+  .action(async ({ dir, force }) => {
+    const api = apiClient();
+    const { playbooks } = await api.get("/v2/playbooks");
+    const docs = (playbooks || []).filter((p) => PULL_KINDS[p.kind] && (p.body_md || "").trim());
+    if (!docs.length) {
+      console.log("Nothing to pull — your Vault has no context docs yet. Set one up in the app first.");
+      return;
+    }
+
+    const ctxDir = join(resolve(dir), "context");
+    if (!existsSync(ctxDir)) mkdirSync(ctxDir, { recursive: true });
+
+    let written = 0, skipped = 0, synced = 0;
+    for (const p of docs) {
+      const rel = join("context", PULL_KINDS[p.kind]);
+      const abs = join(resolve(dir), rel);
+      if (existsSync(abs) && !force) {
+        console.log(dim(`  skip  ${rel} (exists — pass --force to overwrite)`));
+        skipped++;
+        continue;
+      }
+      writeFileSync(abs, p.body_md.trim() + "\n");
+      written++;
+      console.log(`  write ${rel}`);
+      // Re-sync WITH the path so the graph now knows the repo is the author.
+      try {
+        await api.post(`/v2/playbooks/${p.kind}`, { body_md: p.body_md, file_path: rel });
+        synced++;
+      } catch { /* the file is written; a failed authorship flip is non-fatal, re-run pull */ }
+    }
+
+    console.log(`\n✓ ${written} written${skipped ? `, ${skipped} skipped` : ""}. Your repo now owns your context.`);
+    if (synced < written) console.log(dim("  (some didn't sync back — re-run `nous pull` to finish)"));
+    console.log(dim("Edit these files and your agent syncs them with sync_playbook. Nous mirrors them."));
+  });
+
+// nous logout — top-level alias of `auth logout`. Removes the saved API key.
+program
+  .command("logout")
+  .description("Sign out — remove the saved API key")
+  .action(() => {
+    const cfg = readConfig();
+    if (!cfg.apiKey) { console.log("Not signed in."); return; }
+    delete cfg.apiKey;
+    writeConfig(cfg);
+    console.log("✓ Signed out — removed the saved API key from ~/.nous/config.json");
   });
 
 // ---------------------------------------------------------------------------
-program.name("nous").version("0.5.0").parse();
+program.name("nous").version("0.7.0").parse();