@sleepwalkerai/cli 0.1.0

package/README.md

@@ -0,0 +1,134 @@
+# Sleepwalker CLI
+
+Command-line client for the Sleepwalker API.
+
+This package is intentionally a thin API client. It does not run Sleepwalker
+analysis locally.
+
+Public package:
+
+```text
+@sleepwalkerai/cli
+```
+
+Install it from npm or run it directly with `npx`.
+
+## Install
+
+```bash
+npm install -g @sleepwalkerai/cli
+sleepwalker init
+sleepwalker auth key set sw_api_live_...
+sleepwalker menu
+sleepwalker doctor
+```
+
+One-off usage:
+
+```bash
+npx @sleepwalkerai/cli doctor
+```
+
+## Local Usage
+
+From this repository:
+
+```bash
+cd packages/cli
+node ./bin/sleepwalker.js
+node ./bin/sleepwalker.js menu
+node ./bin/sleepwalker.js init
+node ./bin/sleepwalker.js commands
+```
+
+With an API key:
+
+```bash
+export SLEEPWALKER_API_KEY=sw_api_live_...
+node ./bin/sleepwalker.js credits
+```
+
+Or store the key locally:
+
+```bash
+node ./bin/sleepwalker.js auth key set sw_api_live_...
+node ./bin/sleepwalker.js doctor
+```
+
+To point the CLI at a non-production API base:
+
+```bash
+node ./bin/sleepwalker.js config set api-base-url https://api.sleepwalker.ai
+node ./bin/sleepwalker.js config show
+```
+
+## Examples
+
+```bash
+sleepwalker init
+sleepwalker menu
+sleepwalker doctor
+sleepwalker page serialize https://www.sleepwalker.ai
+sleepwalker reports by-url https://www.sleepwalker.ai
+sleepwalker visibility run https://www.sleepwalker.ai --brand Sleepwalker --prompt "What are the best AI visibility tools?" --platform perplexity --watch
+sleepwalker ci score https://www.sleepwalker.ai
+sleepwalker ci run https://www.sleepwalker.ai --depth full --watch
+sleepwalker activity list
+```
+
+Add `--json` to print raw API responses.
+
+For retryable scripts, pass your own idempotency key on persisted run creation:
+
+```bash
+sleepwalker visibility run https://www.sleepwalker.ai \
+  --brand Sleepwalker \
+  --prompt "What are the best AI visibility tools?" \
+  --platform perplexity \
+  --idempotency-key visibility-sleepwalker-homepage-001
+```
+
+`--watch` polls for completion and stops after 15 minutes by default. Override
+that with `--max-wait-seconds <seconds>` when a workflow needs a shorter or
+longer wait.
+
+## Smoke Tests
+
+Local command smoke:
+
+```bash
+npm run smoke
+```
+
+Read-only live smoke with a real API key:
+
+```bash
+export SLEEPWALKER_API_KEY=sw_api_live_...
+npm run smoke:live
+```
+
+The live smoke does not run billable actions by default. To include one
+intentional serialization action:
+
+```bash
+SLEEPWALKER_CLI_SMOKE_WRITE=1 npm run smoke:live
+```
+
+## Terminal Color
+
+Human output uses Sleepwalker-inspired terminal color when the terminal supports
+it:
+
+- green for successful AI Visibility / completed states;
+- purple for Content Intelligence;
+- cyan/blue for IDs, URLs, and API paths;
+- yellow/red for queued, blocked, or failed work.
+
+Colors are never added to `--json` output. Set `NO_COLOR=1` to disable styling
+or `FORCE_COLOR=1` to force it in supported terminals.
+
+If your current shell exports `NO_COLOR`, remove it while previewing:
+
+```bash
+env -u NO_COLOR FORCE_COLOR=1 node ./bin/sleepwalker.js --help
+```

package/bin/sleepwalker.js

@@ -0,0 +1,15 @@
+#!/usr/bin/env node
+
+import { main } from "../src/cli.js";
+
+main(process.argv.slice(2), {
+  stdin: process.stdin,
+  stdout: process.stdout,
+  stderr: process.stderr,
+  env: process.env,
+  fetch: globalThis.fetch,
+}).catch((error) => {
+  const message = error && error.message ? error.message : String(error);
+  process.stderr.write(`Sleepwalker CLI error: ${message}\n`);
+  process.exitCode = typeof error.exitCode === "number" ? error.exitCode : 1;
+});

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@sleepwalkerai/cli",
+  "version": "0.1.0",
+  "description": "Command-line client for the Sleepwalker API.",
+  "type": "module",
+  "bin": {
+    "sleepwalker": "bin/sleepwalker.js"
+  },
+  "scripts": {
+    "test": "node --test",
+    "smoke": "node ./bin/sleepwalker.js --help",
+    "smoke:live": "node ./scripts/smoke.js"
+  },
+  "engines": {
+    "node": ">=18.17"
+  },
+  "files": [
+    "bin",
+    "src",
+    "scripts",
+    "README.md"
+  ],
+  "license": "MIT"
+}

package/scripts/smoke.js

@@ -0,0 +1,57 @@
+#!/usr/bin/env node
+import { execFile } from "node:child_process";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import { promisify } from "node:util";
+
+const execFileAsync = promisify(execFile);
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const cliPath = path.resolve(__dirname, "../bin/sleepwalker.js");
+
+async function run(args, { env = process.env } = {}) {
+  const label = `sleepwalker ${args.join(" ")}`;
+  process.stdout.write(`\n> ${label}\n`);
+  const { stdout, stderr } = await execFileAsync(process.execPath, [cliPath, ...args], {
+    env: { ...env, NO_COLOR: "1" },
+    maxBuffer: 1024 * 1024 * 8,
+  });
+  if (stdout.trim()) {
+    process.stdout.write(`${stdout.trim()}\n`);
+  }
+  if (stderr.trim()) {
+    process.stderr.write(`${stderr.trim()}\n`);
+  }
+}
+
+async function main() {
+  await run(["--help"]);
+
+  if (!process.env.SLEEPWALKER_API_KEY) {
+    process.stdout.write("\nNo SLEEPWALKER_API_KEY set. Live read smoke skipped.\n");
+    process.stdout.write("Set SLEEPWALKER_API_KEY to smoke-test the hosted API without spending credits.\n");
+    return;
+  }
+
+  await run(["doctor", "--json"]);
+  await run(["credits", "--json"]);
+  await run(["tests", "list", "--limit", "1", "--json"]);
+  await run(["activity", "list", "--limit", "1", "--json"]);
+
+  if (process.env.SLEEPWALKER_CLI_SMOKE_WRITE === "1") {
+    const url = process.env.SLEEPWALKER_CLI_SMOKE_WRITE_URL || "https://www.sleepwalker.ai";
+    await run(["page", "serialize", url, "--max-chars", "1000", "--json"]);
+  } else {
+    process.stdout.write("\nWrite smoke skipped. Set SLEEPWALKER_CLI_SMOKE_WRITE=1 to include a billable action.\n");
+  }
+}
+
+main().catch((error) => {
+  process.stderr.write(`\nSmoke failed: ${error.message}\n`);
+  if (error.stdout) {
+    process.stderr.write(`${error.stdout}\n`);
+  }
+  if (error.stderr) {
+    process.stderr.write(`${error.stderr}\n`);
+  }
+  process.exitCode = 1;
+});

package/src/args.js

@@ -0,0 +1,79 @@
+import fs from "node:fs";
+
+export function parseFlags(args) {
+  const positional = [];
+  const flags = {};
+
+  for (let index = 0; index < args.length; index += 1) {
+    const arg = args[index];
+    if (!arg.startsWith("--") || arg === "--") {
+      positional.push(arg);
+      continue;
+    }
+
+    const withoutPrefix = arg.slice(2);
+    const [rawKey, inlineValue] = withoutPrefix.split(/=(.*)/s);
+    const key = rawKey.trim();
+    if (!key) {
+      continue;
+    }
+
+    let value = inlineValue;
+    if (value === undefined) {
+      const next = args[index + 1];
+      if (next !== undefined && !next.startsWith("--")) {
+        value = next;
+        index += 1;
+      } else {
+        value = true;
+      }
+    }
+
+    if (flags[key] === undefined) {
+      flags[key] = value;
+    } else if (Array.isArray(flags[key])) {
+      flags[key].push(value);
+    } else {
+      flags[key] = [flags[key], value];
+    }
+  }
+
+  return { positional, flags };
+}
+
+export function flagList(flags, name) {
+  const value = flags[name];
+  if (value === undefined || value === false) {
+    return [];
+  }
+  return Array.isArray(value) ? value.map(String) : [String(value)];
+}
+
+export function flagString(flags, name, fallback = "") {
+  const value = flags[name];
+  if (value === undefined || value === true || value === false) {
+    return fallback;
+  }
+  return Array.isArray(value) ? String(value[value.length - 1]) : String(value);
+}
+
+export function flagNumber(flags, name, fallback) {
+  const value = flagString(flags, name, "");
+  if (!value) {
+    return fallback;
+  }
+  const parsed = Number(value);
+  return Number.isFinite(parsed) ? parsed : fallback;
+}
+
+export function flagBool(flags, name) {
+  return Boolean(flags[name]);
+}
+
+export function readLinesFromFile(filePath) {
+  const raw = fs.readFileSync(filePath, "utf8");
+  return raw
+    .split(/\r?\n/)
+    .map((line) => line.trim())
+    .filter(Boolean);
+}