@quintinshaw/pi-dynamic-workflows 1.2.0 → 1.3.0

package/README.md

@@ -46,6 +46,18 @@ The model writes a workflow script and calls the `workflow` tool. Live progress
 
 Press `Esc` to cancel a running run; active subagents are aborted and surfaced as skipped.
 
+### Background runs & `/workflows`
+
+Ask for a background workflow (the model passes `background: true`) and it runs without blocking your session. Manage it with the `/workflows` command:
+
+```text
+/workflows                 # list runs (default)
+/workflows status <id>     # show a run's progress
+/workflows stop <id>       # abort a running run
+/workflows pause <id>      # pause a running run
+/workflows rm <id>         # remove a run from the list
+```
+
 ## Workflow script shape
 
 A workflow is plain JavaScript. The first statement must export literal metadata:
@@ -121,6 +133,7 @@ Scripts run inside a Node `vm` sandbox. Intentionally unavailable: `Date.now()`,
 - **Structured output** — JSON-Schema-validated subagent results
 - **Real token & cost accounting** — read from each subagent's SDK session (input / output / total / cost), with a character estimate only as fallback when a provider reports no usage; `budget` gates on the real total
 - **Real per-agent / per-phase model routing** — `opts.model` and `meta.phases[].model` actually select the model (resolved against your authed model registry), with graceful fallback
+- **`/workflows` command** — list, inspect, stop, pause, and remove background runs; runs started with `background: true` are reachable from the command
 - **Safety limits** — 1000-agent cap (`maxAgents`), per-agent timeout (`agentTimeoutMs`), recoverable-vs-fatal error classification
 - **Live progress + token/cost display**, `Esc` to abort
 - **Log persistence** to `.pi/workflows/runs/`
@@ -129,7 +142,6 @@ Scripts run inside a Node `vm` sandbox. Intentionally unavailable: `Date.now()`,
 
 Tracked toward closer parity with Claude Code dynamic workflows:
 
-- **Command surface** — `/workflows` (list / status / stop) and reachable background runs
 - **Resume** — journaled results, replay the unchanged prefix, run the rest live
 - **Worktree isolation** for parallel edits, and **bundled `/deep-research`**
 - **Saved workflows** as `/<name>` slash commands

package/dist/index.d.ts

@@ -20,6 +20,7 @@ export type { StructuredOutputCapture, StructuredOutputToolOptions } from "./str
 export { createStructuredOutputTool } from "./structured-output.js";
 export type { AgentOptions, WorkflowMeta, WorkflowMetaPhase, WorkflowRunOptions, WorkflowRunResult, } from "./workflow.js";
 export { parseWorkflowScript, runWorkflow } from "./workflow.js";
+export { registerWorkflowCommands } from "./workflow-commands.js";
 export type { ManagedRun, WorkflowManagerOptions } from "./workflow-manager.js";
 export { WorkflowManager } from "./workflow-manager.js";
 export type { SavedWorkflow, WorkflowStorage } from "./workflow-saved.js";

package/dist/index.js

@@ -10,6 +10,7 @@ export { buildModelRoutingInstructions, parseModelRoutingFromMeta, resolveModelF
 export { createRunPersistence, generateRunId } from "./run-persistence.js";
 export { createStructuredOutputTool } from "./structured-output.js";
 export { parseWorkflowScript, runWorkflow } from "./workflow.js";
+export { registerWorkflowCommands } from "./workflow-commands.js";
 export { WorkflowManager } from "./workflow-manager.js";
 export { createWorkflowStorage } from "./workflow-saved.js";
 export { createWorkflowTool } from "./workflow-tool.js";

package/dist/workflow-commands.d.ts

@@ -0,0 +1,8 @@
+/**
+ * `/workflows` slash command: list, inspect, and control background workflow runs.
+ * Shares the extension's single WorkflowManager so background runs are reachable.
+ */
+import type { ExtensionAPI } from "@earendil-works/pi-coding-agent";
+import type { WorkflowManager } from "./workflow-manager.js";
+/** Register the `/workflows` command against the shared manager. Idempotent. */
+export declare function registerWorkflowCommands(pi: ExtensionAPI, manager: WorkflowManager): void;

package/dist/workflow-commands.js

@@ -0,0 +1,111 @@
+/**
+ * `/workflows` slash command: list, inspect, and control background workflow runs.
+ * Shares the extension's single WorkflowManager so background runs are reachable.
+ */
+import { renderWorkflowText } from "./display.js";
+const STATUS_ICON = {
+    pending: "·",
+    running: "◆",
+    paused: "⏸",
+    completed: "✓",
+    failed: "✗",
+    aborted: "⊘",
+};
+const USAGE = "Usage: /workflows [list] | status <id> | stop <id> | pause <id> | resume <id> | rm <id>";
+function summarizeRun(run) {
+    const icon = STATUS_ICON[run.status] ?? "?";
+    const done = run.agents.filter((a) => a.status === "done").length;
+    const total = run.agents.length;
+    const tokens = run.tokenUsage ? ` · ${run.tokenUsage.total.toLocaleString()} tok` : "";
+    return `${icon} ${run.runId}  ${run.workflowName} [${run.status}] ${done}/${total} agents${tokens}`;
+}
+function renderPersistedStatus(run) {
+    const lines = [`${STATUS_ICON[run.status] ?? "?"} ${run.workflowName} (${run.runId}) — ${run.status}`];
+    if (run.currentPhase)
+        lines.push(`  phase: ${run.currentPhase}`);
+    for (const agent of run.agents) {
+        const icon = agent.status === "done" ? "✓" : agent.status === "error" ? "✗" : agent.status === "running" ? "◆" : "·";
+        lines.push(`  ${icon} ${agent.label}`);
+    }
+    if (run.tokenUsage)
+        lines.push(`  tokens: ${run.tokenUsage.total.toLocaleString()}`);
+    if (run.durationMs)
+        lines.push(`  duration: ${(run.durationMs / 1000).toFixed(1)}s`);
+    return lines.join("\n");
+}
+/** Register the `/workflows` command against the shared manager. Idempotent. */
+export function registerWorkflowCommands(pi, manager) {
+    try {
+        const taken = (pi.getCommands?.() ?? []).some((c) => c.name === "workflows");
+        if (taken)
+            return;
+    }
+    catch {
+        // getCommands may be unavailable in some hosts; fall through and try to register.
+    }
+    pi.registerCommand("workflows", {
+        description: "List and control background workflow runs",
+        async handler(args, ctx) {
+            const parts = args.trim().split(/\s+/).filter(Boolean);
+            const sub = (parts[0] ?? "list").toLowerCase();
+            const id = parts[1];
+            const print = (text) => pi.sendMessage({ customType: "workflows", content: text, display: true });
+            switch (sub) {
+                case "list": {
+                    const runs = manager.listRuns();
+                    if (!runs.length) {
+                        await print("No workflow runs yet. Start one with a background workflow (background: true).");
+                        return;
+                    }
+                    await print(["Workflow runs:", ...runs.map(summarizeRun), "", USAGE].join("\n"));
+                    return;
+                }
+                case "status": {
+                    if (!id) {
+                        ctx.ui.notify(USAGE, "warning");
+                        return;
+                    }
+                    const live = manager.getSnapshot(id);
+                    if (live) {
+                        await print(renderWorkflowText(live, false));
+                        return;
+                    }
+                    const run = manager.listRuns().find((r) => r.runId === id);
+                    if (!run) {
+                        ctx.ui.notify(`No workflow run "${id}"`, "error");
+                        return;
+                    }
+                    await print(renderPersistedStatus(run));
+                    return;
+                }
+                case "stop": {
+                    if (!id)
+                        return ctx.ui.notify(USAGE, "warning");
+                    ctx.ui.notify(manager.stop(id) ? `Stopped ${id}` : `Cannot stop ${id} (not running)`, manager.getRun(id) ? "info" : "warning");
+                    return;
+                }
+                case "pause": {
+                    if (!id)
+                        return ctx.ui.notify(USAGE, "warning");
+                    ctx.ui.notify(manager.pause(id) ? `Paused ${id}` : `Cannot pause ${id} (not running)`, "info");
+                    return;
+                }
+                case "resume": {
+                    if (!id)
+                        return ctx.ui.notify(USAGE, "warning");
+                    const ok = await manager.resume(id);
+                    ctx.ui.notify(ok ? `Resumed ${id}` : `Resume not available for ${id} yet`, ok ? "info" : "warning");
+                    return;
+                }
+                case "rm": {
+                    if (!id)
+                        return ctx.ui.notify(USAGE, "warning");
+                    ctx.ui.notify(manager.deleteRun(id) ? `Removed ${id}` : `No run ${id}`, "info");
+                    return;
+                }
+                default:
+                    ctx.ui.notify(`Unknown subcommand "${sub}". ${USAGE}`, "warning");
+            }
+        },
+    });
+}

package/dist/workflow-tool.d.ts

@@ -1,5 +1,7 @@
 import { type ToolDefinition } from "@earendil-works/pi-coding-agent";
 import { Type } from "typebox";
+import { WorkflowManager } from "./workflow-manager.js";
+import { type WorkflowStorage } from "./workflow-saved.js";
 declare const workflowToolSchema: Type.TObject<{
     script: Type.TString;
     args: Type.TOptional<Type.TAny>;
@@ -17,6 +19,10 @@ export type WorkflowToolInput = {
 export interface WorkflowToolOptions {
     cwd?: string;
     concurrency?: number;
+    /** Shared manager so background runs are reachable from the `/workflows` command. */
+    manager?: WorkflowManager;
+    /** Shared saved-workflow storage. */
+    storage?: WorkflowStorage;
 }
 export declare function createWorkflowTool(options?: WorkflowToolOptions): ToolDefinition<typeof workflowToolSchema, any>;
 export {};

package/dist/workflow-tool.js

@@ -27,8 +27,8 @@ const workflowToolSchema = Type.Object({
     })),
 });
 export function createWorkflowTool(options = {}) {
-    const manager = new WorkflowManager({ cwd: options.cwd, concurrency: options.concurrency });
-    const _storage = createWorkflowStorage(options.cwd ?? process.cwd());
+    const manager = options.manager ?? new WorkflowManager({ cwd: options.cwd, concurrency: options.concurrency });
+    const _storage = options.storage ?? createWorkflowStorage(options.cwd ?? process.cwd());
     return defineTool({
         name: "workflow",
         label: "Workflow",
@@ -70,8 +70,8 @@ export function createWorkflowTool(options = {}) {
                             text: [
                                 `Workflow "${parsed.meta.name}" started in background.`,
                                 `Run ID: ${runId}`,
-                                `Use /workflow status ${runId} to check progress.`,
-                                `Use /workflow stop ${runId} to cancel.`,
+                                `Use /workflows status ${runId} to check progress.`,
+                                `Use /workflows stop ${runId} to cancel.`,
                             ].join("\n"),
                         },
                     ],

package/extensions/workflow.ts

@@ -1,9 +1,16 @@
 import type { ExtensionAPI } from "@earendil-works/pi-coding-agent";
-import { createWorkflowTool } from "../src/index.js";
+import { createWorkflowStorage, createWorkflowTool, registerWorkflowCommands, WorkflowManager } from "../src/index.js";
 
 export default function extension(pi: ExtensionAPI) {
-  const workflowTool = createWorkflowTool();
+  // Single manager/storage shared by the workflow tool and the /workflows command,
+  // so background runs started by the tool are reachable from the command.
+  const cwd = process.cwd();
+  const manager = new WorkflowManager({ cwd });
+  const storage = createWorkflowStorage(cwd);
+
+  const workflowTool = createWorkflowTool({ cwd, manager, storage });
   pi.registerTool(workflowTool);
+  registerWorkflowCommands(pi, manager);
 
   pi.on("session_start", () => {
     const active = pi.getActiveTools();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quintinshaw/pi-dynamic-workflows",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Claude-Code-style dynamic workflow orchestration for Pi.",
   "type": "module",
   "main": "./dist/index.js",

package/src/index.ts

@@ -47,6 +47,7 @@ export type {
   WorkflowRunResult,
 } from "./workflow.js";
 export { parseWorkflowScript, runWorkflow } from "./workflow.js";
+export { registerWorkflowCommands } from "./workflow-commands.js";
 export type { ManagedRun, WorkflowManagerOptions } from "./workflow-manager.js";
 export { WorkflowManager } from "./workflow-manager.js";
 export type { SavedWorkflow, WorkflowStorage } from "./workflow-saved.js";

package/src/workflow-commands.ts

@@ -0,0 +1,117 @@
+/**
+ * `/workflows` slash command: list, inspect, and control background workflow runs.
+ * Shares the extension's single WorkflowManager so background runs are reachable.
+ */
+
+import type { ExtensionAPI, ExtensionCommandContext } from "@earendil-works/pi-coding-agent";
+import { renderWorkflowText } from "./display.js";
+import type { PersistedRunState } from "./run-persistence.js";
+import type { WorkflowManager } from "./workflow-manager.js";
+
+const STATUS_ICON: Record<string, string> = {
+  pending: "·",
+  running: "◆",
+  paused: "⏸",
+  completed: "✓",
+  failed: "✗",
+  aborted: "⊘",
+};
+
+const USAGE = "Usage: /workflows [list] | status <id> | stop <id> | pause <id> | resume <id> | rm <id>";
+
+function summarizeRun(run: PersistedRunState): string {
+  const icon = STATUS_ICON[run.status] ?? "?";
+  const done = run.agents.filter((a) => a.status === "done").length;
+  const total = run.agents.length;
+  const tokens = run.tokenUsage ? ` · ${run.tokenUsage.total.toLocaleString()} tok` : "";
+  return `${icon} ${run.runId}  ${run.workflowName} [${run.status}] ${done}/${total} agents${tokens}`;
+}
+
+function renderPersistedStatus(run: PersistedRunState): string {
+  const lines = [`${STATUS_ICON[run.status] ?? "?"} ${run.workflowName} (${run.runId}) — ${run.status}`];
+  if (run.currentPhase) lines.push(`  phase: ${run.currentPhase}`);
+  for (const agent of run.agents) {
+    const icon =
+      agent.status === "done" ? "✓" : agent.status === "error" ? "✗" : agent.status === "running" ? "◆" : "·";
+    lines.push(`  ${icon} ${agent.label}`);
+  }
+  if (run.tokenUsage) lines.push(`  tokens: ${run.tokenUsage.total.toLocaleString()}`);
+  if (run.durationMs) lines.push(`  duration: ${(run.durationMs / 1000).toFixed(1)}s`);
+  return lines.join("\n");
+}
+
+/** Register the `/workflows` command against the shared manager. Idempotent. */
+export function registerWorkflowCommands(pi: ExtensionAPI, manager: WorkflowManager): void {
+  try {
+    const taken = (pi.getCommands?.() ?? []).some((c: { name: string }) => c.name === "workflows");
+    if (taken) return;
+  } catch {
+    // getCommands may be unavailable in some hosts; fall through and try to register.
+  }
+
+  pi.registerCommand("workflows", {
+    description: "List and control background workflow runs",
+    async handler(args: string, ctx: ExtensionCommandContext) {
+      const parts = args.trim().split(/\s+/).filter(Boolean);
+      const sub = (parts[0] ?? "list").toLowerCase();
+      const id = parts[1];
+      const print = (text: string) => pi.sendMessage({ customType: "workflows", content: text, display: true });
+
+      switch (sub) {
+        case "list": {
+          const runs = manager.listRuns();
+          if (!runs.length) {
+            await print("No workflow runs yet. Start one with a background workflow (background: true).");
+            return;
+          }
+          await print(["Workflow runs:", ...runs.map(summarizeRun), "", USAGE].join("\n"));
+          return;
+        }
+        case "status": {
+          if (!id) {
+            ctx.ui.notify(USAGE, "warning");
+            return;
+          }
+          const live = manager.getSnapshot(id);
+          if (live) {
+            await print(renderWorkflowText(live, false));
+            return;
+          }
+          const run = manager.listRuns().find((r) => r.runId === id);
+          if (!run) {
+            ctx.ui.notify(`No workflow run "${id}"`, "error");
+            return;
+          }
+          await print(renderPersistedStatus(run));
+          return;
+        }
+        case "stop": {
+          if (!id) return ctx.ui.notify(USAGE, "warning");
+          ctx.ui.notify(
+            manager.stop(id) ? `Stopped ${id}` : `Cannot stop ${id} (not running)`,
+            manager.getRun(id) ? "info" : "warning",
+          );
+          return;
+        }
+        case "pause": {
+          if (!id) return ctx.ui.notify(USAGE, "warning");
+          ctx.ui.notify(manager.pause(id) ? `Paused ${id}` : `Cannot pause ${id} (not running)`, "info");
+          return;
+        }
+        case "resume": {
+          if (!id) return ctx.ui.notify(USAGE, "warning");
+          const ok = await manager.resume(id);
+          ctx.ui.notify(ok ? `Resumed ${id}` : `Resume not available for ${id} yet`, ok ? "info" : "warning");
+          return;
+        }
+        case "rm": {
+          if (!id) return ctx.ui.notify(USAGE, "warning");
+          ctx.ui.notify(manager.deleteRun(id) ? `Removed ${id}` : `No run ${id}`, "info");
+          return;
+        }
+        default:
+          ctx.ui.notify(`Unknown subcommand "${sub}". ${USAGE}`, "warning");
+      }
+    },
+  });
+}

package/src/workflow-tool.ts

@@ -12,7 +12,7 @@ import {
 import { WorkflowError, WorkflowErrorCode } from "./errors.js";
 import { parseWorkflowScript, runWorkflow, type WorkflowRunResult } from "./workflow.js";
 import { WorkflowManager } from "./workflow-manager.js";
-import { createWorkflowStorage } from "./workflow-saved.js";
+import { createWorkflowStorage, type WorkflowStorage } from "./workflow-saved.js";
 
 const workflowToolSchema = Type.Object({
   script: Type.String({
@@ -54,11 +54,15 @@ export type WorkflowToolInput = {
 export interface WorkflowToolOptions {
   cwd?: string;
   concurrency?: number;
+  /** Shared manager so background runs are reachable from the `/workflows` command. */
+  manager?: WorkflowManager;
+  /** Shared saved-workflow storage. */
+  storage?: WorkflowStorage;
 }
 
 export function createWorkflowTool(options: WorkflowToolOptions = {}): ToolDefinition<typeof workflowToolSchema, any> {
-  const manager = new WorkflowManager({ cwd: options.cwd, concurrency: options.concurrency });
-  const _storage = createWorkflowStorage(options.cwd ?? process.cwd());
+  const manager = options.manager ?? new WorkflowManager({ cwd: options.cwd, concurrency: options.concurrency });
+  const _storage = options.storage ?? createWorkflowStorage(options.cwd ?? process.cwd());
 
   return defineTool({
     name: "workflow",
@@ -103,8 +107,8 @@ export function createWorkflowTool(options: WorkflowToolOptions = {}): ToolDefin
               text: [
                 `Workflow "${parsed.meta.name}" started in background.`,
                 `Run ID: ${runId}`,
-                `Use /workflow status ${runId} to check progress.`,
-                `Use /workflow stop ${runId} to cancel.`,
+                `Use /workflows status ${runId} to check progress.`,
+                `Use /workflows stop ${runId} to cancel.`,
               ].join("\n"),
             },
           ],