rivet-design 0.12.4 → 0.13.1

package/dist/install/codexGuidance.js

@@ -0,0 +1,90 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeCodexGuidance = exports.writeCodexGuidance = exports.codexAgentsPath = void 0;
+const fs_1 = __importDefault(require("fs"));
+const os_1 = __importDefault(require("os"));
+const path_1 = __importDefault(require("path"));
+const cli_guidance_1 = require("../utils/skills/cli-guidance");
+/**
+ * Codex guidance: a marker-delimited Rivet section appended to the global
+ * `~/.codex/AGENTS.md` (Codex's user-scope instructions file). Install
+ * replaces the section between the markers; uninstall removes exactly it,
+ * leaving the user's own instructions untouched.
+ */
+const SECTION_BEGIN = '<!-- BEGIN RIVET (written by `rivet install codex`) -->';
+const SECTION_END = '<!-- END RIVET -->';
+const codexAgentsPath = (homeDir = os_1.default.homedir()) => path_1.default.join(homeDir, '.codex', 'AGENTS.md');
+exports.codexAgentsPath = codexAgentsPath;
+const buildSection = () => [
+    SECTION_BEGIN,
+    `<!-- rivet-cli-guidance-version: ${cli_guidance_1.CLI_GUIDANCE_VERSION} -->`,
+    '# Rivet',
+    '',
+    cli_guidance_1.CLI_GUIDANCE_BODY,
+    SECTION_END,
+].join('\n');
+const stripSection = (contents) => {
+    const begin = contents.indexOf(SECTION_BEGIN);
+    if (begin === -1)
+        return contents;
+    const end = contents.indexOf(SECTION_END, begin);
+    if (end === -1)
+        return contents;
+    const before = contents.slice(0, begin).replace(/\n+$/, '\n');
+    const after = contents.slice(end + SECTION_END.length).replace(/^\n+/, '\n');
+    return `${before}${after}`.trim() ? `${before}${after}` : '';
+};
+const writeCodexGuidance = (homeDir = os_1.default.homedir()) => {
+    const filePath = (0, exports.codexAgentsPath)(homeDir);
+    try {
+        const existing = fs_1.default.existsSync(filePath)
+            ? fs_1.default.readFileSync(filePath, 'utf8')
+            : '';
+        const withoutSection = stripSection(existing);
+        const next = withoutSection
+            ? `${withoutSection.replace(/\n+$/, '')}\n\n${buildSection()}\n`
+            : `${buildSection()}\n`;
+        if (next === existing) {
+            return { ok: true, changed: false };
+        }
+        fs_1.default.mkdirSync(path_1.default.dirname(filePath), { recursive: true });
+        fs_1.default.writeFileSync(filePath, next, 'utf8');
+        return { ok: true, changed: true };
+    }
+    catch (err) {
+        return {
+            ok: false,
+            error: err instanceof Error ? err.message : String(err),
+        };
+    }
+};
+exports.writeCodexGuidance = writeCodexGuidance;
+const removeCodexGuidance = (homeDir = os_1.default.homedir()) => {
+    const filePath = (0, exports.codexAgentsPath)(homeDir);
+    if (!fs_1.default.existsSync(filePath))
+        return { ok: true, changed: false };
+    try {
+        const existing = fs_1.default.readFileSync(filePath, 'utf8');
+        const next = stripSection(existing);
+        if (next === existing)
+            return { ok: true, changed: false };
+        if (next.trim() === '') {
+            fs_1.default.unlinkSync(filePath);
+        }
+        else {
+            fs_1.default.writeFileSync(filePath, next, 'utf8');
+        }
+        return { ok: true, changed: true };
+    }
+    catch (err) {
+        return {
+            ok: false,
+            error: err instanceof Error ? err.message : String(err),
+        };
+    }
+};
+exports.removeCodexGuidance = removeCodexGuidance;
+//# sourceMappingURL=codexGuidance.js.map

package/dist/install/codexGuidance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"codexGuidance.js","sourceRoot":"","sources":["../../src/install/codexGuidance.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAoB;AACpB,4CAAoB;AACpB,gDAAwB;AACxB,+DAGsC;AAEtC;;;;;GAKG;AAEH,MAAM,aAAa,GAAG,yDAAyD,CAAC;AAChF,MAAM,WAAW,GAAG,oBAAoB,CAAC;AAElC,MAAM,eAAe,GAAG,CAAC,UAAkB,YAAE,CAAC,OAAO,EAAE,EAAU,EAAE,CACxE,cAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;AAD/B,QAAA,eAAe,mBACgB;AAE5C,MAAM,YAAY,GAAG,GAAW,EAAE,CAChC;IACE,aAAa;IACb,oCAAoC,mCAAoB,MAAM;IAC9D,SAAS;IACT,EAAE;IACF,gCAAiB;IACjB,WAAW;CACZ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAEf,MAAM,YAAY,GAAG,CAAC,QAAgB,EAAU,EAAE;IAChD,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IAC9C,IAAI,KAAK,KAAK,CAAC,CAAC;QAAE,OAAO,QAAQ,CAAC;IAClC,MAAM,GAAG,GAAG,QAAQ,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IACjD,IAAI,GAAG,KAAK,CAAC,CAAC;QAAE,OAAO,QAAQ,CAAC;IAChC,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC9D,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC7E,OAAO,GAAG,MAAM,GAAG,KAAK,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;AAC/D,CAAC,CAAC;AAKK,MAAM,kBAAkB,GAAG,CAChC,UAAkB,YAAE,CAAC,OAAO,EAAE,EACd,EAAE;IAClB,MAAM,QAAQ,GAAG,IAAA,uBAAe,EAAC,OAAO,CAAC,CAAC;IAC1C,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,YAAE,CAAC,UAAU,CAAC,QAAQ,CAAC;YACtC,CAAC,CAAC,YAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC;YACnC,CAAC,CAAC,EAAE,CAAC;QACP,MAAM,cAAc,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC9C,MAAM,IAAI,GAAG,cAAc;YACzB,CAAC,CAAC,GAAG,cAAc,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,YAAY,EAAE,IAAI;YAChE,CAAC,CAAC,GAAG,YAAY,EAAE,IAAI,CAAC;QAC1B,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;YACtB,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;QACtC,CAAC;QACD,YAAE,CAAC,SAAS,CAAC,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC1D,YAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QACzC,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IACrC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO;YACL,EAAE,EAAE,KAAK;YACT,KAAK,EAAE,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;SACxD,CAAC;IACJ,CAAC;AACH,CAAC,CAAC;AAxBW,QAAA,kBAAkB,sBAwB7B;AAEK,MAAM,mBAAmB,GAAG,CACjC,UAAkB,YAAE,CAAC,OAAO,EAAE,EACd,EAAE;IAClB,MAAM,QAAQ,GAAG,IAAA,uBAAe,EAAC,OAAO,CAAC,CAAC;IAC1C,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,QAAQ,CAAC;QAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;IAClE,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,YAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QACnD,MAAM,IAAI,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;QACpC,IAAI,IAAI,KAAK,QAAQ;YAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;QAC3D,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YACvB,YAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAC1B,CAAC;aAAM,CAAC;YACN,YAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QAC3C,CAAC;QACD,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IACrC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO;YACL,EAAE,EAAE,KAAK;YACT,KAAK,EAAE,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;SACxD,CAAC;IACJ,CAAC;AACH,CAAC,CAAC;AArBW,QAAA,mBAAmB,uBAqB9B"}

package/dist/install/harnesses.d.ts

@@ -1,16 +1,32 @@
+import { verifyCodexRules } from './allowlists';
 /**
  * Outcome of installing Rivet into a single harness.
- * `ok` — the MCP server is registered (or was already). `changed` — config was
- * actually written this run. Methods never call process.exit so the unified
- * "install everywhere" loop can keep going past a single failure.
+ * `ok` — the agent is set up for CLI-first Rivet (or was already).
+ * `changed` — config was actually written this run. Methods never call
+ * process.exit so the unified "install everywhere" loop can keep going past
+ * a single failure.
  */
 export type InstallOutcome = {
     ok: boolean;
     changed: boolean;
 };
+/**
+ * Options for one install run. `mcp` is the opt-in from `rivet install
+ * --mcp`: additionally register the resident `rivet mcp serve` stdio server
+ * with the host (docs/perf-mcp-design.md, Phase 4). The CLI remains the
+ * default agent interface; the flag is additive, never a replacement.
+ */
+export type HarnessInstallOptions = {
+    mcp?: boolean;
+};
 /**
  * A single agent harness Rivet can install into (Claude Code, Cursor, …).
  *
+ * Installing means: write the host's CLI-usage guidance (rules/skill file),
+ * write the host's user-scope command allowlist so agent invocations of
+ * `rivet` never hit an approval prompt, and clean up any MCP registration an
+ * earlier Rivet version wrote. Uninstall removes exactly what install wrote.
+ *
  * This interface is the *only* place harnesses are enumerated. `install`,
  * `uninstall`, and `update` are all driven by iterating `HARNESSES`, so adding
  * a new editor is one registry entry rather than edits across five call sites.
@@ -20,18 +36,29 @@ export interface Harness {
     id: string;
     /** Human label used in progress and summary output. */
     label: string;
-    /** Label for the in-app "Send to …" button (consumed by the MCP server). */
+    /** Label for the in-app "Send to …" button. */
     sendButtonLabel: string;
     /** Where to send a user whose harness isn't installed yet. */
     installUrl: string;
+    /**
+     * Retired targets are kept for uninstall/cleanup but skipped by the
+     * install-everywhere flow; explicit installs print why.
+     */
+    isRetired?: boolean;
+    /**
+     * True when `--mcp` can register the resident stdio server with this
+     * harness. Lets a retired harness (Claude Desktop) re-enter the
+     * install-everywhere flow for MCP-only setup.
+     */
+    supportsMcp?: boolean;
     /** True when this harness appears present on the machine. */
     detect(): boolean;
     /** Message shown when a user explicitly targets a harness that isn't present. */
     notInstalledMessage(): string;
-    install(): InstallOutcome;
+    install(options?: HarnessInstallOptions): InstallOutcome;
     /** Returns whether anything was actually removed. */
     uninstall(): boolean;
-    /** Re-register only if already installed. Returns whether it updated. */
+    /** Refresh guidance/allowlists only if already installed. Returns whether it updated. */
     update(): boolean;
     /** Multi-line "Next steps" block printed after a single-target install. */
     nextSteps: string;
@@ -40,26 +67,9 @@ export interface Harness {
     /** Harness-specific guidance printed after a single-target uninstall changed something. */
     restartHint: string;
 }
-/**
- * Resolve `npx` to an absolute path using the install-time shell PATH.
- *
- * Why: editors like Claude desktop inherit a sanitized PATH at launch that can
- * put stale node versions first, causing `npx` to dispatch to a node so old it
- * can't even `require('node:url')`. Writing the absolute path into the MCP
- * config bypasses that lookup. Falls back to literal "npx" with a warning so
- * install never hard-blocks on a quirky environment.
- */
-export declare const resolveNpxCommand: () => string;
-export declare const buildCursorHostedRivetEntry: () => {
-    url: string;
-};
-export declare const buildCursorLocalRivetEntry: () => {
-    command: string;
-    args: string[];
-};
 export declare const HARNESSES: Harness[];
 export declare const findHarness: (id: string) => Harness | undefined;
-export declare const detectedHarnesses: () => Harness[];
+export declare const detectedHarnesses: (options?: HarnessInstallOptions) => Harness[];
 /** Label for the in-app "Send to …" button, by harness id. */
 export declare const sendButtonLabelFor: (id?: string) => string;
 /**
@@ -67,7 +77,7 @@ export declare const sendButtonLabelFor: (id?: string) => string;
  * (`target` undefined/`'all'`). Returns a process exit code; never exits
  * itself so the multi-install loop survives a single failure.
  */
-export declare const installHarnesses: (target?: string) => {
+export declare const installHarnesses: (target?: string, options?: HarnessInstallOptions) => {
     exitCode: number;
 };
 /**
@@ -77,6 +87,7 @@ export declare const installHarnesses: (target?: string) => {
 export declare const uninstallHarnesses: (target?: string) => {
     exitCode: number;
 };
-/** Re-register Rivet for every detected, already-installed harness. */
+/** Refresh guidance/allowlists for every detected, already-installed harness. */
 export declare const updateHarnesses: () => void;
+export { verifyCodexRules };
 //# sourceMappingURL=harnesses.d.ts.map

package/dist/install/harnesses.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"harnesses.d.ts","sourceRoot":"","sources":["../../src/install/harnesses.ts"],"names":[],"mappings":"AAOA;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG;IAAE,EAAE,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,OAAO,CAAA;CAAE,CAAC;AAE/D;;;;;;GAMG;AACH,MAAM,WAAW,OAAO;IACtB,kEAAkE;IAClE,EAAE,EAAE,MAAM,CAAC;IACX,uDAAuD;IACvD,KAAK,EAAE,MAAM,CAAC;IACd,4EAA4E;IAC5E,eAAe,EAAE,MAAM,CAAC;IACxB,8DAA8D;IAC9D,UAAU,EAAE,MAAM,CAAC;IACnB,6DAA6D;IAC7D,MAAM,IAAI,OAAO,CAAC;IAClB,iFAAiF;IACjF,mBAAmB,IAAI,MAAM,CAAC;IAC9B,OAAO,IAAI,cAAc,CAAC;IAC1B,qDAAqD;IACrD,SAAS,IAAI,OAAO,CAAC;IACrB,yEAAyE;IACzE,MAAM,IAAI,OAAO,CAAC;IAClB,2EAA2E;IAC3E,SAAS,EAAE,MAAM,CAAC;IAClB,kFAAkF;IAClF,WAAW,EAAE,MAAM,CAAC;IACpB,2FAA2F;IAC3F,WAAW,EAAE,MAAM,CAAC;CACrB;AAMD;;;;;;;;GAQG;AACH,eAAO,MAAM,iBAAiB,QAAO,MA4BpC,CAAC;AAiIF,eAAO,MAAM,2BAA2B;;CAEtC,CAAC;AAgBH,eAAO,MAAM,0BAA0B;;;CAGrC,CAAC;AAwVH,eAAO,MAAM,SAAS,EAAE,OAAO,EAiF9B,CAAC;AAEF,eAAO,MAAM,WAAW,GAAI,IAAI,MAAM,KAAG,OAAO,GAAG,SACf,CAAC;AAErC,eAAO,MAAM,iBAAiB,QAAO,OAAO,EACP,CAAC;AAEtC,8DAA8D;AAC9D,eAAO,MAAM,kBAAkB,GAAI,KAAK,MAAM,KAAG,MACkB,CAAC;AAiBpE;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,GAAI,SAAS,MAAM,KAAG;IAAE,QAAQ,EAAE,MAAM,CAAA;CA0EpE,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,kBAAkB,GAAI,SAAS,MAAM,KAAG;IAAE,QAAQ,EAAE,MAAM,CAAA;CAkCtE,CAAC;AAEF,uEAAuE;AACvE,eAAO,MAAM,eAAe,QAAO,IAUlC,CAAC"}
+{"version":3,"file":"harnesses.d.ts","sourceRoot":"","sources":["../../src/install/harnesses.ts"],"names":[],"mappings":"AAMA,OAAO,EAIL,gBAAgB,EAQjB,MAAM,cAAc,CAAC;AAwBtB;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG;IAAE,EAAE,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,OAAO,CAAA;CAAE,CAAC;AAE/D;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAAE,GAAG,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC;AAEtD;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,OAAO;IACtB,kEAAkE;IAClE,EAAE,EAAE,MAAM,CAAC;IACX,uDAAuD;IACvD,KAAK,EAAE,MAAM,CAAC;IACd,+CAA+C;IAC/C,eAAe,EAAE,MAAM,CAAC;IACxB,8DAA8D;IAC9D,UAAU,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,6DAA6D;IAC7D,MAAM,IAAI,OAAO,CAAC;IAClB,iFAAiF;IACjF,mBAAmB,IAAI,MAAM,CAAC;IAC9B,OAAO,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,cAAc,CAAC;IACzD,qDAAqD;IACrD,SAAS,IAAI,OAAO,CAAC;IACrB,yFAAyF;IACzF,MAAM,IAAI,OAAO,CAAC;IAClB,2EAA2E;IAC3E,SAAS,EAAE,MAAM,CAAC;IAClB,kFAAkF;IAClF,WAAW,EAAE,MAAM,CAAC;IACpB,2FAA2F;IAC3F,WAAW,EAAE,MAAM,CAAC;CACrB;AA6XD,eAAO,MAAM,SAAS,EAAE,OAAO,EAK9B,CAAC;AAEF,eAAO,MAAM,WAAW,GAAI,IAAI,MAAM,KAAG,OAAO,GAAG,SACf,CAAC;AAErC,eAAO,MAAM,iBAAiB,GAC5B,UAAU,qBAAqB,KAC9B,OAAO,EAKP,CAAC;AAEJ,8DAA8D;AAC9D,eAAO,MAAM,kBAAkB,GAAI,KAAK,MAAM,KAAG,MACkB,CAAC;AAqBpE;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,GAC3B,SAAS,MAAM,EACf,UAAU,qBAAqB,KAC9B;IAAE,QAAQ,EAAE,MAAM,CAAA;CA2EpB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,kBAAkB,GAAI,SAAS,MAAM,KAAG;IAAE,QAAQ,EAAE,MAAM,CAAA;CAkCtE,CAAC;AAEF,iFAAiF;AACjF,eAAO,MAAM,eAAe,QAAO,IAUlC,CAAC;AAEF,OAAO,EAAE,gBAAgB,EAAE,CAAC"}