@golproductions/check 3.1.6 → 3.1.8

package/README.md

@@ -1,54 +1,101 @@
-# Check -- The Universal Anti-Hallucination Engine
+# Check
 
-AI agents hallucinate. Check catches it before it reaches your project.
+**The anti-hallucination engine for AI agents.** Your agent invents a command, a package, a URL. Check catches it before it runs. No AI inside — deterministic, sub-100ms.
 
-No AI inside. Deterministic. Sub-100ms.
+**This is the one location.** Everything integrates from here:
 
-## Install
+```
+npx @golproductions/check --install       # Windows, macOS, Linux
+curl check.golproductions.com | sh        # Unix shells
+```
+
+Installing mints a free key bound to your machine — no signup, 120 free checks per day, and the same key is shared by every Check tool on the machine. Need more? Get a paid GOL API Key at [the console](https://www.golproductions.com/console.html).
+
+---
+
+## Integrate it into anything
+
+Check is one primitive with four faces. Pick the one your environment speaks.
+
+### 1. Hook mode — blocks bad commands before they run
+
+For any tool with pre-execution hooks. `--install` wires these automatically for **Claude Code, Cursor, and Gemini CLI**; wire anything else yourself: pipe the hook JSON to the script, read the verdict.
 
 ```
-npx @golproductions/check --install
+echo '{"tool_input":{"command":"some command"}}' | node ~/.check/check.mjs
+→ {"hookSpecificOutput":{"permissionDecision":"allow"}}          # runnable
+→ {"hookSpecificOutput":{"permissionDecision":"deny", ...}}      # hallucinated
 ```
 
-One command. It auto-detects your AI tools, wires them up, and activates a free key on first run. No signup, no API key to paste, no browser.
+The script auto-detects Claude Code, Cursor, and Gemini hook formats and answers in each tool's own dialect.
 
-## Supported environments
+### 2. MCP server — for anything that speaks Model Context Protocol
 
-Claude Code, Cursor, Gemini CLI, Windsurf, Devin Desktop, Continue, Amazon Q, Roo Code, Claude Desktop, JetBrains, VS Code, Neovim, Emacs, Sublime Text, Zed, and any MCP client.
+Windsurf, Antigravity, Continue, Amazon Q, Roo Code, Claude Desktop, or your own agent:
+
+```json
+{
+  "mcpServers": {
+    "check": {
+      "command": "npx",
+      "args": ["@golproductions/check", "--mcp"],
+      "env": { "GOL_CLIENT_ID": "your_key" }
+    }
+  }
+}
+```
 
-## Pricing
+Exposes two tools: `Check` (verdict only) and `CheckAndExecute` (validate, then run if clean). MCP is advisory — the agent calls it when its rules say to. Add one line to your agent's rules: *"Before running any shell command, validate it with the `check` tool."*
 
-120 free checks every day. After that, $0.0068 AUD per check. No subscription. Credits never expire.
+### 3. CLI — for scripts, CI, git hooks, anything with a shell
 
-| Tier | Checks |
-|------|--------|
-| Free | 120 / day |
-| $5 | ~735 |
-| $10 | ~1,470 |
-| $25 | ~3,676 |
-| $50 | ~7,352 |
+```
+curl check.golproductions.com | sh       # installs the `check` command (Unix)
+check "netlify-cli deploy --prod"        # → invalid   (exit 1)
+check "netlify deploy --prod"            # → runnable  (exit 0)
+echo "some command" | check              # pipe mode
+```
 
-## Bring your own key (optional)
+Exit codes make it composable: gate a CI step, a git pre-push hook, a Docker entrypoint, a cron job.
 
-A key is minted for you automatically. If you already have a Client ID, or want the same one across machines, set it and Check uses that instead:
+### 4. HTTP — for everything else, in any language
 
 ```
-export GOL_CLIENT_ID=your_key
+POST https://triage.golproductions.com/preflight
+Header: X-GOL-CLIENT-ID: your_key
+Body:   {"command": "the command to validate"}
+
+→ {"verdict": "runnable" | "invalid", "reason": "...", "daily_remaining": 119}
 ```
 
+That is the whole contract. Rate limit 60/min. A `402` means the free tier is spent and the balance is empty — treat it as allow-with-warning, never as a verdict.
+
+---
+
+## Keys
+
+| Tier | What | Where |
+|------|------|-------|
+| **GOL Client ID** — free | Minted automatically on install, bound to the machine, shared by every tool on it. 120 checks/day, forever. | Nowhere — it just happens |
+| **GOL API Key** — paid | Prepaid balance ($0.0068 AUD/check after the daily 120), spend caps, dashboard, 2FA. | [Console](https://www.golproductions.com/console.html) |
+
+Same header, same API — the tier is just what the key can do.
+
 ## Manage
 
 ```
-npx @golproductions/check --status      Show your client ID and where Check is installed
-npx @golproductions/check --uninstall   Remove Check from every tool
+npx @golproductions/check --status      Your key + where Check is installed
+npx @golproductions/check --credits     Balance and free checks remaining
+npx @golproductions/check --uninstall   Remove from every tool
 ```
 
+## Editor extensions
+
+Thin wrappers over this same API exist on the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=golproductions.gol-check), [Open VSX](https://open-vsx.org/extension/golproductions/gol-check) (also used by Antigravity), and the [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/32408). They validate on demand; the hook and MCP faces above are the real-time gate.
+
 ## Links
 
-- [Product page](https://www.golproductions.com/check.html)
-- [Pricing](https://www.golproductions.com/pricing.html)
-- [Updates](https://www.golproductions.com/updates.html)
-- [Blog](https://www.golproductions.com/blog/)
+[Product](https://www.golproductions.com/check.html) · [Pricing](https://www.golproductions.com/pricing.html) · [Console](https://www.golproductions.com/console.html) · [Updates](https://www.golproductions.com/updates.html) · [Blog](https://www.golproductions.com/blog/)
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@golproductions/check",
-  "version": "3.1.6",
+  "version": "3.1.8",
   "description": "The universal anti-hallucination engine for AI coding agents. Catches what is not real before it reaches your project.",
   "bin": {
     "check": "src/index.js",

package/src/index.js

@@ -5,7 +5,7 @@ import { homedir, platform, arch } from "node:os";
 import { pipeline } from "node:stream/promises";
 import { Readable } from "node:stream";
 
-const VERSION = "3.1.6";
+const VERSION = "3.1.8";
 const BINARY_VERSION = "3.0.0";
 const API = "https://triage.golproductions.com/preflight";
 const CDN = "https://pub-e55366a7f5994be9be04f0e205179f4a.r2.dev/releases";
@@ -292,9 +292,10 @@ async function install() {
     }
   } catch {}
 
-  console.log(`\n  Your key:  ${key}`);
-  console.log(`  Link it to your email at https://www.golproductions.com/console`);
-  console.log(`  (optional — keeps credits, top-ups, and your dashboard in one place)`);
+  console.log(`\n  Your free GOL Client ID (this machine):  ${key}`);
+  console.log(`  Shared by every editor on this machine. 120 free checks/day.`);
+  console.log(`  Need more? Get a GOL API Key (paid, prepaid balance) at`);
+  console.log(`  https://www.golproductions.com/console`);
   console.log(`\nSafe travels wanderer..\n`);
   process.exit(0);
 }

package/src/mcp.js

@@ -6,7 +6,7 @@ import { execFile } from "node:child_process";
 import { promisify } from "node:util";
 
 const execFileAsync = promisify(execFile);
-const VERSION = "3.1.6";
+const VERSION = "3.1.8";
 const API = "https://triage.golproductions.com/preflight";
 const CLIENT_ID = process.env.GOL_CLIENT_ID;
 const IS_WIN = process.platform === "win32";