@crewkit/cli 0.4.0 → 0.5.0

package/README.md

@@ -66,22 +66,47 @@ npm install -g @crewkit/cli
 brew install karibew/tap/crewkit
 ```
 
-### Chocolatey (Windows)
+### Windows — use WSL
 
-```powershell
-choco install crewkit
+```bash
+wsl npm install -g @crewkit/cli
 ```
 
+This package ships no native Windows binary: those builds are paused. On native
+Windows `npm install -g @crewkit/cli` still installs — and says so — but the CLI
+refuses to run and points you here. The Chocolatey package (`choco install
+crewkit`) is frozen at 0.4.1 and no longer follows releases. WSL is the better
+target anyway — background observation is Unix-only.
+
 ### Direct Download
 
 See [GitHub Releases](https://github.com/karibew/crewkit-cli/releases) for platform-specific binaries.
 
+### Shell completions
+
+Tab completions for bash, zsh, fish, and PowerShell (Homebrew installs them
+automatically):
+
+```bash
+# bash
+echo 'source <(crewkit completions bash)' >> ~/.bashrc
+
+# zsh — add fpath+=~/.zfunc to ~/.zshrc before compinit
+mkdir -p ~/.zfunc && crewkit completions zsh > ~/.zfunc/_crewkit
+
+# fish
+mkdir -p ~/.config/fish/completions && crewkit completions fish > ~/.config/fish/completions/crewkit.fish
+```
+
+`crewkit completions --help` has the full per-shell setup, including PowerShell.
+
 ## Supported Platforms
 
 - macOS Apple Silicon (M1/M2/M3/M4)
-- macOS Intel
 - Linux x64
-- Windows x64
+- Windows x64 — via WSL (install the Linux build there)
+
+Not published: macOS Intel, and native Windows (paused).
 
 ## Requirements
 

package/lib/getBinary.js

@@ -11,6 +11,27 @@ const PLATFORMS = {
   'win32-x64': '@crewkit/cli-win32-x64',
 };
 
+// Platforms whose package is NOT published. The generic "reinstall" advice
+// below can never succeed for these — it would loop the user forever — so they
+// get a truthful refusal naming what actually works. Shared with
+// scripts/postinstall.js so the install banner and the run-time refusal cannot
+// disagree. Restoring a build means deleting one entry.
+const UNAVAILABLE = {
+  'win32-x64': {
+    what: 'a native Windows binary',
+    // Windows is a pause, and WSL is a real remedy today.
+    remedy:
+      `Run crewkit under WSL and install the Linux build there:\n` +
+      `  wsl npm install -g @crewkit/cli\n\n` +
+      `WSL is the better target anyway: background observation is Unix-only.`,
+  },
+  'darwin-x64': {
+    what: 'a macOS Intel (x86_64) binary',
+    // No cross-arch remedy exists: Rosetta translates x86 to arm, not back.
+    remedy: `Supported today: macOS Apple Silicon, Linux x64, and Windows via WSL.`,
+  },
+};
+
 function getPlatformKey() {
   return `${process.platform}-${process.arch}`;
 }
@@ -71,6 +92,16 @@ function getBinaryPath() {
     }
   }
 
+  const unavailable = UNAVAILABLE[platformKey];
+  if (unavailable) {
+    throw new Error(
+      `crewkit does not currently ship ${unavailable.what}.\n\n` +
+      `${unavailable.remedy}\n\n` +
+      `Or set CREWKIT_BINARY_PATH to point to a crewkit binary you built.\n\n` +
+      `For more help, visit: https://github.com/karibew/crewkit-cli/issues`
+    );
+  }
+
   // Binary not found
   throw new Error(
     `Could not find crewkit binary for ${platformKey}.\n\n` +
@@ -85,4 +116,4 @@ function getBinaryPath() {
   );
 }
 
-module.exports = { getBinaryPath, getPlatformKey, PLATFORMS };
+module.exports = { getBinaryPath, getPlatformKey, PLATFORMS, UNAVAILABLE };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crewkit/cli",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Manage Claude Code agents for teams - role-based configs, A/B testing, accuracy tracking",
   "author": "crewkit <hello@crewkit.io>",
   "license": "SEE LICENSE IN LICENSE",
@@ -38,15 +38,14 @@
     "README.md"
   ],
   "scripts": {
-    "postinstall": "node scripts/postinstall.js"
+    "postinstall": "node scripts/postinstall.js",
+    "test": "node test/getBinary.test.js"
   },
   "engines": {
     "node": ">=18"
   },
   "optionalDependencies": {
-    "@crewkit/cli-darwin-arm64": "0.4.0",
-    "@crewkit/cli-darwin-x64": "0.4.0",
-    "@crewkit/cli-linux-x64": "0.4.0",
-    "@crewkit/cli-win32-x64": "0.4.0"
+    "@crewkit/cli-darwin-arm64": "0.5.0",
+    "@crewkit/cli-linux-x64": "0.5.0"
   }
 }

package/scripts/postinstall.js

@@ -23,6 +23,27 @@ const BOLD = '\x1b[1m';
 const DIM = '\x1b[2m';
 const CYAN = '\x1b[36m';
 const GREEN = '\x1b[32m';
+const YELLOW = '\x1b[33m';
+
+// On a platform we publish no binary for, the install itself SUCCEEDS (the
+// optional dependency is simply absent) and only `crewkit` fails, at first
+// run. Congratulating the user here and refusing a second later is the worst
+// of both, so say it now, from the same table the refusal uses.
+const { getPlatformKey, UNAVAILABLE } = require('../lib/getBinary.js');
+const unavailable = UNAVAILABLE[getPlatformKey()];
+
+if (unavailable) {
+  console.log();
+  console.log(`${BOLD}${YELLOW}crewkit${RESET} installed, but it cannot run on this platform.`);
+  console.log();
+  console.log(`crewkit does not currently ship ${unavailable.what}.`);
+  console.log();
+  console.log(unavailable.remedy);
+  console.log();
+  console.log(`${DIM}Docs:${RESET} https://crewkit.io/docs/installation`);
+  console.log();
+  process.exit(0);
+}
 
 console.log();
 console.log(`${BOLD}${GREEN}crewkit${RESET} installed successfully!`);