@cg3/equip 0.2.8 → 0.2.9

package/README.md

@@ -6,17 +6,35 @@ Equip handles the hard part of distributing your MCP tool: detecting which AI co
 
 ## Supported Platforms
 
+Equip supports **11 platforms** across two tiers, depending on whether the platform has a writable location for behavioral rules.
+
+### Full Support — MCP + Behavioral Rules
+
+These platforms get both MCP server config *and* auto-installed behavioral rules. Rules teach agents *when* to use your tool (e.g., "search before debugging") and are versioned for idempotent updates.
+
 | Platform | MCP Config | Rules |
 |---|---|---|
 | Claude Code | `~/.claude.json` (JSON, `mcpServers`) | `~/.claude/CLAUDE.md` (append) |
-| Cursor | `~/.cursor/mcp.json` (JSON, `mcpServers`) | Clipboard (no writable global path) |
 | Windsurf | `~/.codeium/windsurf/mcp_config.json` (JSON, `mcpServers`) | `global_rules.md` (append) |
-| VS Code | `Code/User/mcp.json` (JSON, `servers`, `type: "http"`) | Clipboard |
 | Cline | `globalStorage/.../cline_mcp_settings.json` (JSON, `mcpServers`) | `~/Documents/Cline/Rules/` (standalone file) |
 | Roo Code | `globalStorage/.../cline_mcp_settings.json` (JSON, `mcpServers`) | `~/.roo/rules/` (standalone file) |
 | Codex | `~/.codex/config.toml` (TOML, `mcp_servers`) | `~/.codex/AGENTS.md` (append) |
 | Gemini CLI | `~/.gemini/settings.json` (JSON, `mcpServers`, `httpUrl`) | `~/.gemini/GEMINI.md` (append) |
 
+### MCP Only — No Writable Rules Path
+
+These platforms get MCP server config but don't have a writable global rules file (`rulesPath: null`). The MCP tools work fine — but equip can't auto-install behavioral rules.
+
+| Platform | MCP Config |
+|---|---|
+| Cursor | `~/.cursor/mcp.json` (JSON, `mcpServers`) |
+| VS Code | `Code/User/mcp.json` (JSON, `servers`, `type: "http"`) |
+| Junie (JetBrains) | `~/.junie/mcp/mcp.json` (JSON, `mcpServers`) |
+| Copilot (JetBrains) | `~/.config/github-copilot/intellij/mcp.json` (JSON, `mcpServers`) |
+| Copilot CLI | `~/.copilot/mcp-config.json` (JSON, `mcpServers`) |
+
+For these platforms, `installRules()` returns `{ action: "clipboard" }` if the platform is in the configurable `clipboardPlatforms` list (default: `["cursor", "vscode"]`), or `{ action: "skipped" }` otherwise. It's up to the consumer to decide how to handle this — e.g., copying rules to the clipboard, printing instructions, or skipping silently.
+
 ## Quick Start
 
 ```bash
@@ -25,6 +43,28 @@ npx @cg3/equip prior
 
 That's it. Detects your platforms, authenticates, installs MCP + rules, and verifies — all in one command. Pass `--dry-run` to preview without writing files.
 
+## CLI Usage
+
+You can invoke any npm package that has an equip-based setup command:
+
+```bash
+# Full package name + command
+npx @cg3/equip @cg3/prior-node setup
+
+# Shorthand (if registered)
+npx @cg3/equip prior
+```
+
+The CLI runs `npx -y <package>@latest <command>` with any extra args forwarded (e.g. `--dry-run`, `--platform codex`).
+
+### Shorthand Registry
+
+Registered shorthands save typing. Open a PR to `bin/equip.js` to add yours:
+
+| Shorthand | Expands to |
+|---|---|
+| `prior` | `@cg3/prior-node setup` |
+
 ## Programmatic Usage
 
 ```js
@@ -94,6 +134,7 @@ const { detectPlatforms, installMcpJson, installRules, createManualPlatform, pla
 ## Key Features
 
 - **Zero dependencies** — Pure Node.js, works with Node 18+
+- **11 platforms** — Covers ~80% of active AI coding tool users
 - **Platform-aware** — Handles each platform's config quirks (JSON vs TOML, root keys, URL fields, type requirements)
 - **Non-destructive** — Merges into existing configs, creates backups, preserves other servers
 - **Versioned rules** — Marker-based blocks enable idempotent updates without clobbering user content

package/bin/equip.js

@@ -36,10 +36,33 @@ if (!alias || alias === "--help" || alias === "-h") {
 }
 
 const entry = TOOLS[alias];
+
+// No registry match — treat as a package name (e.g. "@scope/pkg setup")
 if (!entry) {
-  console.error(`Unknown tool: ${alias}`);
-  console.error(`Available: ${Object.keys(TOOLS).join(", ")}`);
-  process.exit(1);
+  const pkg = alias;
+  const command = extraArgs.shift(); // first extra arg is the command
+  if (!command) {
+    console.error(`Usage: npx @cg3/equip <package> <command> [options]`);
+    console.error(`   or: npx @cg3/equip <shorthand> [options]`);
+    console.error("");
+    console.error("Registered shorthands:");
+    for (const [name, info] of Object.entries(TOOLS)) {
+      console.log(`  ${name}  →  ${info.package} ${info.command}`);
+    }
+    process.exit(1);
+  }
+  const npxCmd = process.platform === "win32" ? "npx.cmd" : "npx";
+  const child = spawn(npxCmd, ["-y", `${pkg}@latest`, command, ...extraArgs], {
+    stdio: "inherit",
+    shell: process.platform === "win32",
+    env: { ...process.env, EQUIP_VERSION },
+  });
+  child.on("close", (code) => process.exit(code || 0));
+  child.on("error", (err) => {
+    console.error(`Failed to run ${pkg}: ${err.message}`);
+    process.exit(1);
+  });
+  return;
 }
 
 // Spawn: npx -y <package> <command> [...extraArgs]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cg3/equip",
-  "version": "0.2.8",
+  "version": "0.2.9",
   "description": "Universal MCP + behavioral rules installer for AI coding agents",
   "main": "index.js",
   "bin": {