impact-compass 0.2.2 → 0.2.3

package/README.md

@@ -2,6 +2,11 @@
 
 *grab a compass before you sail soldier*
 
+```bash
+npm i impact-compass
+npx impact-compass idea.json output.json
+```
+
 A purely statistical, deterministic project idea validator and market research CLI.
 
 Impact Compass fetches keyword rankings and engagement signals from real sources like GitHub, npm, Reddit, Stack Exchange, Hacker News, Wikipedia, and the App Store. It checks the *hype* around your project before you waste six months, a billion tokens, and enough coffee to make your keyboard anxious.
@@ -59,11 +64,11 @@ The engine spits out a final score out of 100, along with a brutally honest inte
 
 ## Quickstart
 
-Install dependencies, then run an evaluation:
+Install the published package, then run an evaluation:
 
 ```bash
-npm install
-npm run cli example-react.json output.json
+npm i impact-compass
+npx impact-compass idea.json output.json
 ```
 
 ### The Input Schema

package/bin/impact-compass.js

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+/* eslint-disable @typescript-eslint/no-require-imports */
+const { spawnSync } = require("node:child_process");
+const path = require("node:path");
+
+const tsxCli = require.resolve("tsx/cli");
+const cliEntry = path.resolve(__dirname, "../src/cli.ts");
+const result = spawnSync(process.execPath, [tsxCli, cliEntry, ...process.argv.slice(2)], {
+  stdio: "inherit",
+});
+
+if (result.error) {
+  console.error(result.error.message);
+  process.exit(1);
+}
+
+process.exit(result.status ?? 1);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "impact-compass",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "description": "Deterministic market research CLI for startup idea validation, demand scoring, and competitive analysis.",
   "license": "MIT",
   "repository": {
@@ -12,6 +12,9 @@
     "url": "https://github.com/adityachauhan0/impact-compass/issues"
   },
   "private": false,
+  "bin": {
+    "impact-compass": "./bin/impact-compass.js"
+  },
   "keywords": [
     "market-research",
     "idea-validation",
@@ -40,6 +43,7 @@
     "stackexchange"
   ],
   "files": [
+    "bin/",
     "src/",
     "DOCUMENTATION.md",
     "SKILLS.md",
@@ -59,7 +63,8 @@
     "lucide-react": "^1.16.0",
     "next": "16.2.6",
     "react": "19.2.4",
-    "react-dom": "19.2.4"
+    "react-dom": "19.2.4",
+    "tsx": "^4.22.3"
   },
   "devDependencies": {
     "@tailwindcss/postcss": "^4",

package/src/cli.ts

@@ -59,7 +59,7 @@ function wrapText(text: string, width: number): string[] {
 async function main() {
   const args = process.argv.slice(2);
   if (args.length < 2) {
-    console.error(`Usage: npm run cli <input.json> <output.json>`);
+    console.error(`Usage: impact-compass <input.json> <output.json>`);
     process.exit(1);
   }