@illuminis/comprism 0.1.1 → 0.1.3

package/README.md

@@ -4,26 +4,33 @@ The half of CompletionPrism that runs on your machine. It sits between the tool
 you already use and the AI provider, records what finishing your work actually
 cost, and changes nothing about what your tool does.
 
+## Install
+
 ```bash
-npm install && npm run build
+npm install -g @illuminis/comprism
+comprism login
+```
 
-export ANTHROPIC_API_KEY=...      # or OPENAI_API_KEY
-node out/cli.js setup
-node out/cli.js session
-node out/cli.js report
+That is the whole install. It configures itself, including the one line it adds
+to your shell profile, and it says what it touched. npm hides that message by
+default, so add `--foreground-scripts` to the install if you want to read it.
+
+No API key to export. The keys live in your workspace, and every decision is
+made on our servers.
+
+```bash
+comprism check          # what this machine still needs, and how to add it
+comprism uninstall      # takes the line back out
 ```
 
 ## The coding agent
 
-`comprism agent` is a coding agent in your terminal. It reads your project,
-changes files, runs commands, runs your tests, and shows you every change before
-it makes it.
+`comprism work` reads your project, changes files, runs commands, runs your
+tests, and shows you every change before it makes it.
 
 ```bash
-npm install -g @illuminis/comprism
-comprism login                    # once, per machine
 cd ~/your-project
-comprism agent "the tests are failing, work out why and fix it"
+comprism work "the tests are failing, work out why and fix it"
 ```
 
 **What makes it different from the others.** Every step is routed to whichever
@@ -63,7 +70,7 @@ production. Those are yours to do.
 ### Before you let it change anything
 
 ```bash
-comprism agent --plan "rename the parser module and update every caller"
+comprism work --plan "rename the parser module and update every caller"
 ```
 
 It reads what it needs, tells you what it would do, and changes nothing. The
@@ -85,7 +92,7 @@ ran a command, the undo says so plainly rather than claiming to have reversed it
 ### Carrying on tomorrow
 
 ```bash
-comprism agent --resume <job-id> "also add a test for the empty case"
+comprism work --resume <job-id> "also add a test for the empty case"
 ```
 
 It continues the conversation rather than starting a new one, so it already knows
@@ -94,7 +101,7 @@ what it read and decided.
 ### In a script, or in continuous integration
 
 ```bash
-comprism agent --yes --mode auto_edit "run the linter and fix what it reports"
+comprism work --yes --mode auto_edit "run the linter and fix what it reports"
 echo $?     # 0 if it finished, non-zero if it did not
 ```
 
@@ -108,8 +115,8 @@ By default, whichever finishes each step for least. Pin one when you want to
 decide yourself:
 
 ```bash
-comprism agent --model gpt-5 "..."          # or any model your account can reach
-comprism agent --max-spend 2.00 "..."       # stop here rather than running on
+comprism work --model gpt-5 "..."          # or any model your account can reach
+comprism work --max-spend 2.00 "..."       # stop here rather than running on
 ```
 
 Four providers are wired: Anthropic, OpenAI, Google and xAI. Which ones you can
@@ -123,13 +130,13 @@ Node 22 or newer, and a workspace you have signed in to with `comprism login`.
 
 ## Instrument a tool you already use
 
-```bash
-node out/cli.js proxy
-export ANTHROPIC_BASE_URL=http://127.0.0.1:8787
-```
+Nothing to do. The install configured this, by adding one fenced line to your
+shell profile that points your existing tools at the recorder. Open a new
+terminal and `claude` is already measured.
 
 Requests are forwarded to the provider byte for byte. Your key is forwarded,
-never read or stored. Unset the variable and we are gone, with nothing to undo.
+never read or stored. `comprism uninstall` takes the line back out and every
+tool goes straight to its provider again.
 
 ## Whose Anthropic account pays
 
@@ -138,7 +145,7 @@ surface can carry a credential.
 
 | How you work | Where the key comes from | Stored anywhere? |
 |---|---|---|
-| `comprism session`, `comprism proxy`, or an IDE pointed at your workspace | this machine, per request | no |
+| `comprism`, the interception the install configured, or an IDE pointed at your workspace | this machine, per request | no |
 | The developer API and the SDKs | the `X-Anthropic-Key` header, per request | no |
 | Claude Desktop and claude.ai | your workspace's own stored key | yes, encrypted, and only this one |
 
@@ -148,16 +155,14 @@ answering those prompts at all means the workspace holding a key. A workspace
 that holds none gets its connector answers refused - never billed to illuminis.
 
 ```bash
-node out/cli.js key            # whose account pays, here and in your workspace
-node out/cli.js key push       # send this machine's key, for the connector surface
-node out/cli.js key clear      # take it back out
+comprism keys           # whose account pays, here and in your workspace
 ```
 
-`push` is the one command that deliberately sends a provider key anywhere. It
-sends the key this machine already resolves, over TLS, to the workspace you are
-signed in to; Anthropic validates it before it is stored; nothing is written to
-disk here either way. An administrator can do the same in the app, under Policy
-and Data Controls.
+Sending a key to your workspace, for the connector row above, is deliberate and
+it is the one action that puts a provider key anywhere. It goes over TLS to the
+workspace you are signed in to, the provider validates it before it is stored,
+and nothing is written to disk here either way. An administrator can do the same
+in the app, under Policy and Data Controls.
 
 ## The stats footer
 
@@ -192,11 +197,9 @@ failure is logged rather than shown. Nothing is added at all when the turn ends
 in a tool call, a refusal, a truncation, an error event, an empty response, or a
 model with no published price.
 
-```bash
-node out/cli.js footer            # what it is doing now
-node out/cli.js footer off        # byte-faithful in both directions
-node out/cli.js footer on
-```
+Switch it off with `"enabled": false` under `footer` in
+`~/.comprism/config.json`, which makes the proxy byte faithful in both
+directions.
 
 ### Configuring pricing, the baseline and the template
 

package/out/lib/version.d.ts

@@ -6,8 +6,7 @@
  * behavior behind them changes, never on a whim, because consumers select by
  * version and old records keep meaning what they meant.
  */
-/** The package version. Stamped on every row the Companion writes. */
-export declare const COMPRISM_VERSION = "0.1.0";
+export declare const COMPRISM_VERSION: string;
 /** The structural classifier. Bump when a signal is added, removed or retuned. */
 export declare const CLASSIFIER_VERSION = "structural-v1";
 /**

package/out/lib/version.js

@@ -9,8 +9,27 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ESTIMATOR_VERSION = exports.POLICY_VERSION = exports.CLASSIFIER_VERSION = exports.COMPRISM_VERSION = void 0;
-/** The package version. Stamped on every row the Companion writes. */
-exports.COMPRISM_VERSION = '0.1.0';
+/**
+ * The package version. Stamped on every row the Companion writes.
+ *
+ * Read from the package's own manifest rather than typed here. It was typed
+ * here once, and a published 0.1.1 went on reporting itself as 0.1.0 to every
+ * customer and onto every record it wrote, which is the one number a version
+ * stamp exists to get right. A literal drifts the moment `npm version` runs;
+ * the manifest cannot.
+ */
+function packageVersion() {
+    try {
+        // Two levels up from out/lib, which is where the manifest sits in both the
+        // built package and a checkout.
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        return String(require('../../package.json').version || '0.0.0');
+    }
+    catch {
+        return '0.0.0';
+    }
+}
+exports.COMPRISM_VERSION = packageVersion();
 /** The structural classifier. Bump when a signal is added, removed or retuned. */
 exports.CLASSIFIER_VERSION = 'structural-v1';
 /**

package/out/postinstall.js

@@ -61,8 +61,11 @@ async function main() {
             '  Open a new terminal and just work:',
             '    claude            your tools, instrumented, unchanged',
             '    comprism          our own session',
-            '    comprism report   what finishing your work cost',
+            '    comprism check    what this machine still needs',
             '',
+            ...(report.baseUrl
+                ? [`  What your work cost: ${report.baseUrl}`, '']
+                : []),
             '  If our recorder is ever down your tools are unaffected. Undo with `comprism uninstall`.',
             '',
         ].join('\n'));

package/out/thin.js

@@ -86,6 +86,7 @@ function usage() {
         ['comprism status', 'is this machine signed in, and to what'],
         ['comprism check', 'what this machine still needs, and how to add it'],
         ['comprism logout', 'sign out, and revoke this machine\'s key'],
+        ['comprism uninstall', 'undo the setup this machine got at install'],
     ]));
     out();
     out(ui.c.dim(`  v${version_1.COMPRISM_VERSION} · every decision is made on our servers`));
@@ -229,6 +230,31 @@ async function main() {
             out();
             return;
         }
+        // The undo. The install edits a shell profile, and the message it prints
+        // has always promised this command could take the line back out. The
+        // function that does it was written and exported and never wired to a
+        // word, so a customer following our own instruction got "there is no
+        // command called uninstall" and was left to edit their profile by hand.
+        case 'uninstall': {
+            const { uninstall } = await Promise.resolve().then(() => __importStar(require('./commands/install')));
+            const report = uninstall();
+            out();
+            out(ui.banner('Removed from this machine'));
+            out();
+            if (report.profilesCleaned.length === 0) {
+                out(ui.c.dim('  Nothing to take out: no shell profile carried our line.'));
+            }
+            else {
+                for (const profile of report.profilesCleaned) {
+                    out(`  removed our line from ${profile}`);
+                }
+            }
+            out();
+            out(ui.c.dim('  Every AI tool on this machine now talks straight to its provider.'));
+            out(ui.c.dim('  To remove the command itself: npm uninstall -g @illuminis/comprism'));
+            out();
+            return;
+        }
         case '--version':
         case '-v':
             out(version_1.COMPRISM_VERSION);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@illuminis/comprism",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "CompletionPrism Companion. Records what finishing a piece of work actually costs - every attempt, and the human time spent noticing and repairing the ones that failed.",
   "license": "UNLICENSED",
   "private": false,