@boardwalk-labs/cli 0.1.0

package/dist/render/renderer.js

@@ -0,0 +1,108 @@
+// The run-event renderer — one renderer for `boardwalk dev` (and, later, `run --wait` streaming),
+// driven entirely by the SDK's channel mapping so `--stream phase,output` means the same thing
+// everywhere.
+//
+// Line-oriented and pipe-friendly: agent text/reasoning deltas stream raw (no per-delta prefix);
+// everything else renders as one prefixed line. When the subscription is EXACTLY the `output`
+// channel, the output value prints bare (no decoration) so `boardwalk dev --stream output | jq`
+// just works.
+import { CHANNELS, DEFAULT_CHANNELS, matchesChannels, } from "@boardwalk-labs/workflow";
+import { CliError } from "../errors.js";
+/** Resolve `--verbose` / `--stream` to a channel subscription (default: lifecycle+phase+output). */
+export function parseChannels(flags) {
+    if (flags.verbose && flags.stream !== undefined) {
+        throw new CliError("Use either --verbose or --stream <channels>, not both.");
+    }
+    if (flags.verbose)
+        return CHANNELS;
+    if (flags.stream === undefined)
+        return DEFAULT_CHANNELS;
+    const names = flags.stream
+        .split(",")
+        .map((s) => s.trim())
+        .filter((s) => s.length > 0);
+    if (names.length === 0) {
+        throw new CliError(`--stream needs at least one channel (${CHANNELS.join(", ")}).`);
+    }
+    const out = [];
+    for (const name of names) {
+        if (!CHANNELS.includes(name)) {
+            throw new CliError(`Unknown channel "${name}".`, `Valid channels: ${CHANNELS.join(", ")} (or --verbose for all).`);
+        }
+        if (!out.includes(name))
+            out.push(name);
+    }
+    return out;
+}
+/**
+ * Build the renderer. `write` receives raw text (newlines included where intended) — pass
+ * `process.stdout.write` in the CLI, an accumulator in tests.
+ */
+export function createRenderer(channels, write) {
+    const outputOnly = channels.length === 1 && channels[0] === "output";
+    return {
+        render(event) {
+            if (!matchesChannels(event, channels))
+                return;
+            const text = formatEvent(event, outputOnly);
+            if (text !== null)
+                write(text);
+        },
+    };
+}
+function formatEvent(event, outputOnly) {
+    switch (event.kind) {
+        case "run_status": {
+            const line = `● workflow ${event.status}`;
+            if (event.error !== undefined) {
+                return `${line}\n  ${event.error.code}: ${event.error.message}\n`;
+            }
+            return `${line}\n`;
+        }
+        case "phase":
+            return `▸ ${event.name}\n`;
+        case "output": {
+            const value = formatOutputValue(event.value);
+            return outputOnly ? `${value}\n` : `── output ──\n${value}\n`;
+        }
+        case "program_output":
+            // Captured stdout/stderr passes through verbatim (it carries its own newlines).
+            return event.text;
+        case "turn_started":
+            return "· agent turn started\n";
+        case "turn_ended": {
+            const usage = event.usage;
+            const tokens = usage?.totalTokens !== undefined ? ` (${String(usage.totalTokens)} tokens)` : "";
+            const error = event.error !== undefined ? ` — ${event.error.message}` : "";
+            return `· agent turn ${event.reason}${tokens}${error}\n`;
+        }
+        case "text_delta":
+        case "reasoning_delta":
+            return event.text; // stream raw — the model's words ARE the output here
+        case "text_end":
+            return "\n";
+        case "tool_call_start":
+            return `· tool ${event.toolName} …\n`;
+        case "tool_call_result": {
+            const summary = event.result.humanSummary ?? event.result.kind ?? "done";
+            return `· tool result: ${summary}\n`;
+        }
+        case "tool_call_error":
+            return `· tool error: ${event.error.message}\n`;
+        // Structural agent frames with nothing human-readable to print:
+        case "text_start":
+        case "tool_call_input_delta":
+        case "tool_call_input_complete":
+        case "tool_call_executing":
+            return null;
+    }
+}
+function formatOutputValue(value) {
+    if (typeof value === "string")
+        return value;
+    // JSON.stringify returns undefined at runtime for undefined/functions (its types lie).
+    if (value === undefined)
+        return "null";
+    return JSON.stringify(value, null, 2);
+}
+//# sourceMappingURL=renderer.js.map

package/dist/render/renderer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderer.js","sourceRoot":"","sources":["../../src/render/renderer.ts"],"names":[],"mappings":"AAAA,kGAAkG;AAClG,+FAA+F;AAC/F,cAAc;AACd,EAAE;AACF,iGAAiG;AACjG,8FAA8F;AAC9F,gGAAgG;AAChG,cAAc;AAEd,OAAO,EACL,QAAQ,EACR,gBAAgB,EAChB,eAAe,GAGhB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AASxC,oGAAoG;AACpG,MAAM,UAAU,aAAa,CAAC,KAAmB;IAC/C,IAAI,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAChD,MAAM,IAAI,QAAQ,CAAC,wDAAwD,CAAC,CAAC;IAC/E,CAAC;IACD,IAAI,KAAK,CAAC,OAAO;QAAE,OAAO,QAAQ,CAAC;IACnC,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS;QAAE,OAAO,gBAAgB,CAAC;IAExD,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM;SACvB,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;SACpB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC/B,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,MAAM,IAAI,QAAQ,CAAC,wCAAwC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACtF,CAAC;IACD,MAAM,GAAG,GAAc,EAAE,CAAC;IAC1B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,CAAE,QAA8B,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACpD,MAAM,IAAI,QAAQ,CAChB,oBAAoB,IAAI,IAAI,EAC5B,mBAAmB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,0BAA0B,CACjE,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAe,CAAC;YAAE,GAAG,CAAC,IAAI,CAAC,IAAe,CAAC,CAAC;IAChE,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAOD;;;GAGG;AACH,MAAM,UAAU,cAAc,CAC5B,QAA4B,EAC5B,KAA6B;IAE7B,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC;IAErE,OAAO;QACL,MAAM,CAAC,KAAe;YACpB,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,QAAQ,CAAC;gBAAE,OAAO;YAC9C,MAAM,IAAI,GAAG,WAAW,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;YAC5C,IAAI,IAAI,KAAK,IAAI;gBAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QACjC,CAAC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAAC,KAAe,EAAE,UAAmB;IACvD,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,YAAY,CAAC,CAAC,CAAC;YAClB,MAAM,IAAI,GAAG,cAAc,KAAK,CAAC,MAAM,EAAE,CAAC;YAC1C,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBAC9B,OAAO,GAAG,IAAI,OAAO,KAAK,CAAC,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC;YACpE,CAAC;YACD,OAAO,GAAG,IAAI,IAAI,CAAC;QACrB,CAAC;QACD,KAAK,OAAO;YACV,OAAO,KAAK,KAAK,CAAC,IAAI,IAAI,CAAC;QAC7B,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,MAAM,KAAK,GAAG,iBAAiB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC7C,OAAO,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,iBAAiB,KAAK,IAAI,CAAC;QAChE,CAAC;QACD,KAAK,gBAAgB;YACnB,gFAAgF;YAChF,OAAO,KAAK,CAAC,IAAI,CAAC;QACpB,KAAK,cAAc;YACjB,OAAO,wBAAwB,CAAC;QAClC,KAAK,YAAY,CAAC,CAAC,CAAC;YAClB,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;YAC1B,MAAM,MAAM,GACV,KAAK,EAAE,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;YACnF,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC3E,OAAO,gBAAgB,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,KAAK,IAAI,CAAC;QAC3D,CAAC;QACD,KAAK,YAAY,CAAC;QAClB,KAAK,iBAAiB;YACpB,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,qDAAqD;QAC1E,KAAK,UAAU;YACb,OAAO,IAAI,CAAC;QACd,KAAK,iBAAiB;YACpB,OAAO,UAAU,KAAK,CAAC,QAAQ,MAAM,CAAC;QACxC,KAAK,kBAAkB,CAAC,CAAC,CAAC;YACxB,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,YAAY,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC;YACzE,OAAO,kBAAkB,OAAO,IAAI,CAAC;QACvC,CAAC;QACD,KAAK,iBAAiB;YACpB,OAAO,iBAAiB,KAAK,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC;QAClD,gEAAgE;QAChE,KAAK,YAAY,CAAC;QAClB,KAAK,uBAAuB,CAAC;QAC7B,KAAK,0BAA0B,CAAC;QAChC,KAAK,qBAAqB;YACxB,OAAO,IAAI,CAAC;IAChB,CAAC;AACH,CAAC;AAED,SAAS,iBAAiB,CAAC,KAAc;IACvC,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC5C,uFAAuF;IACvF,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,MAAM,CAAC;IACvC,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;AACxC,CAAC"}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@boardwalk-labs/cli",
+  "version": "0.1.0",
+  "description": "The boardwalk CLI: author, validate, run, and deploy Boardwalk workflows.",
+  "license": "MIT",
+  "type": "module",
+  "engines": {
+    "node": ">=24.0.0"
+  },
+  "packageManager": "pnpm@10.23.0",
+  "bin": {
+    "boardwalk": "./bin/boardwalk.js"
+  },
+  "files": [
+    "dist",
+    "bin",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "lint": "eslint . --max-warnings 0",
+    "lint:fix": "eslint . --fix --max-warnings 0",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "coverage": "vitest run --coverage",
+    "boardwalk": "tsx src/index.ts"
+  },
+  "dependencies": {
+    "@boardwalk-labs/workflow": "^0.1.0",
+    "commander": "^13.1.0",
+    "env-paths": "^3.0.0",
+    "esbuild": "^0.25.0",
+    "open": "^10.1.0",
+    "tar": "^7.4.3"
+  },
+  "pnpm": {
+    "onlyBuiltDependencies": [
+      "esbuild"
+    ]
+  },
+  "devDependencies": {
+    "@types/node": "^24.0.0",
+    "@vitest/coverage-v8": "^3.0.0",
+    "eslint": "^9.18.0",
+    "eslint-config-prettier": "^10.1.8",
+    "prettier": "^3.4.0",
+    "tsx": "^4.20.0",
+    "typescript": "^5.6.0",
+    "typescript-eslint": "^8.20.0",
+    "vitest": "^3.0.0"
+  }
+}