ikanban 0.0.0-stage → 0.2.1

package/README.md

@@ -1,3 +1,26 @@
-# Temporary Holding Version
+# ikanban
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The iKanban command line. It scans your own repo on your machine and, when you ask, files the
+results into [iKanban](https://i-kanban.com).
+
+```bash
+npx ikanban secscan                 # dependencies, committed secrets, risky file permissions
+npx ikanban aiscan --help           # red-team scan of your AI app (OWASP LLM Top 10)
+npx ikanban secscan --publish       # also file the report and findings into iKanban
+```
+
+## What you need
+
+- Node.js 18 or newer.
+- Python 3.9 or newer. The scanners are Python; `ikanban` finds `python3`, `python` or `py -3`.
+
+## Free and paid
+
+Scans run on your machine for free, with no account. `--publish` sends the results to iKanban.
+It needs an API token (`--token` or `VIBE_API_TOKEN`) and a team (`--team` or `IKANBAN_TEAM_ID`).
+iKanban checks your plan when you publish; a plan that does not include it gets a clear message.
+
+## What it sends
+
+Nothing, unless you pass `--publish`. With `--publish`, the report and its findings go to iKanban.
+Secrets found in your repo are masked in the report before anything is sent.

package/bin/ikanban.js

@@ -0,0 +1,64 @@
+#!/usr/bin/env node
+// ikanban: one CLI for iKanban. Each command runs a bundled Python scanner.
+// Scans run free on your machine; only --publish talks to iKanban, and the
+// server checks your plan there (a 402 means the plan, not the scan).
+const { spawnSync } = require("node:child_process");
+const path = require("node:path");
+const { version } = require("../package.json");
+
+const COMMANDS = {
+  aiscan: { file: "ikanban-aiscan.py", about: "Red-team scan of your AI app (OWASP LLM Top 10)" },
+  secscan: { file: "ikanban-secscan.py", about: "Dependency, secret and file-permission scan of a repo" },
+};
+
+function help() {
+  const lines = Object.entries(COMMANDS).map(([n, c]) => `  ${n.padEnd(9)}${c.about}`);
+  console.log(`ikanban ${version}
+
+Usage: ikanban <command> [options]
+
+Commands:
+${lines.join("\n")}
+
+Run "ikanban <command> --help" for its options. Add --publish to file the
+results into iKanban (needs an API token; the server checks your plan).
+Needs Python 3.9 or newer.`);
+}
+
+// python3 on macOS/Linux; on Windows usually "py -3" or "python".
+function findPython() {
+  const candidates = process.platform === "win32"
+    ? [["py", ["-3"]], ["python", []], ["python3", []]]
+    : [["python3", []], ["python", []]];
+  for (const [cmd, pre] of candidates) {
+    const r = spawnSync(cmd, [...pre, "-c", "import sys; sys.exit(0 if sys.version_info >= (3, 9) else 1)"]);
+    if (r.status === 0) return [cmd, pre];
+  }
+  return null;
+}
+
+const [cmd, ...args] = process.argv.slice(2);
+if (!cmd || cmd === "help" || cmd === "--help" || cmd === "-h") {
+  help();
+  process.exit(0);
+}
+if (cmd === "--version" || cmd === "-v") {
+  console.log(version);
+  process.exit(0);
+}
+const command = COMMANDS[cmd];
+if (!command) {
+  console.error(`ikanban: unknown command "${cmd}". Run "ikanban --help".`);
+  process.exit(2);
+}
+const python = findPython();
+if (!python) {
+  console.error("ikanban: Python 3.9 or newer was not found. Install it from https://www.python.org/downloads/ and run again.");
+  process.exit(1);
+}
+const [py, pre] = python;
+const script = path.join(__dirname, "..", "scanners", command.file);
+// Windows consoles default to cp1252, which lacks characters the reports print.
+const env = { ...process.env, PYTHONIOENCODING: "utf-8", PYTHONUTF8: "1" };
+const r = spawnSync(py, [...pre, script, ...args], { stdio: "inherit", env });
+process.exit(r.status === null ? 1 : r.status);

package/package.json

@@ -1,6 +1,17 @@
 {
   "name": "ikanban",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.2.1",
+  "description": "iKanban CLI: AI and security scans of your own repo, with results filed into iKanban",
+  "bin": { "ikanban": "bin/ikanban.js" },
+  "files": ["bin", "scanners", "README.md"],
+  "scripts": {
+    "prepack": "node scripts/copy-scanners.js",
+    "pretest": "node scripts/copy-scanners.js",
+    "test": "node --test test/cli.test.js"
+  },
+  "engines": { "node": ">=18" },
+  "homepage": "https://i-kanban.com",
+  "keywords": ["ikanban", "security", "scanner", "ai", "cli"],
+  "author": "VerBodh <support@verbodh.com>",
+  "license": "UNLICENSED"
+}