Document Claude dynamic-workflow conversion and add port sample

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Author: Copilot

README.md

@@ -65,5 +65,7 @@ cat program.ts | node skills/rig/rig.ts --typecheck
 
 ## Docs
 
-See [skills/rig/SKILL.md](skills/rig/SKILL.md) for construction rules and
-[skills/rig/references/runtime.md](skills/rig/references/runtime.md) for launcher and engine details.
+See [skills/rig/SKILL.md](skills/rig/SKILL.md) for construction rules,
+[skills/rig/references/runtime.md](skills/rig/references/runtime.md) for launcher and engine details, and
+[skills/rig/references/claude-workflow-conversion.md](skills/rig/references/claude-workflow-conversion.md)
+for porting Claude Code dynamic workflows to rig.

skills/rig/SKILL.md

@@ -60,6 +60,8 @@ Defaults: `name: "agent"`, `model: "small"`, `maxTurns: 4`, string input/output,
 | Numeric schema choice | `s.int` for counts/line numbers; `s.number` for measurements and ratios |
 | Optional versus nullable | `s.optional(shape)` for omission; `s.nullable(shape)` for explicit `null` |
 | Deterministic TypeScript fan-out | `workflow({ meta, input?, body })` + `export default`; use `call`, `pipeline`, `parallel`, `until` inside `body` |
+| One-off prompt inside a workflow | `call.text(prompt)` for a string, `call.json(prompt, schema)` for structured output |
+| Reusable workflow step | Define an `agent({ input, output })` and `call(worker, input, { label, phase })` |
 | Custom model-callable operation | `defineTool(name, { description, parameters, handler })` |
 | Structured-output retries | `maxTurns` on the agent plus `addons: [repair()]` |
 | Retry with final-turn warning | `addons: [steering(), repair()]` in that order |
@@ -103,6 +105,7 @@ Read only when the task needs the listed detail:
 - [Agent API and schemas](references/agent-api.md) — spec fields, schema overloads, tools, and invocation options.
 - [Prompt intents](references/prompt-intents.md) — complete helper semantics, dynamic inputs, writes, and failure behavior.
 - [Composition and addons](references/composition.md) — delegation patterns, dynamic sets, repair, steering, and addon lifecycle.
-- [Dynamic workflows](references/dynamic-workflows.md) — bounded fan-out, failure semantics, limits, events, and convergence loops.
+- [Dynamic workflows](references/dynamic-workflows.md) — bounded fan-out, failure semantics, limits, budget, events, and convergence loops.
+- [Claude workflow conversion](references/claude-workflow-conversion.md) — mapping Claude Code dynamic-workflow scripts onto rig primitives.
 - [Running and engines](references/runtime.md) — markdown/file launch modes, typechecking, Agentic Workflows, and SDK adapters.
 - [Linting](references/linting.md) — linter usage, autofixes, rules, and rule development.

skills/rig/references/claude-workflow-conversion.md

@@ -0,0 +1,150 @@
+# Converting Claude dynamic workflows to rig
+
+Read this reference when porting a Claude Code dynamic workflow script
+(`.claude/workflows/*.workflow.js`) to a rig `workflow()` program, or when
+comparing the two API surfaces.
+
+A dynamic workflow is a sandboxed JavaScript module that exports a literal
+`meta`, reads `args`, and orchestrates subagents with injected globals
+(`agent`, `parallel`, `pipeline`, `phase`, `log`, `budget`). rig covers the same
+shape with a typed `workflow({ meta, input, body })` whose `body` receives those
+primitives from its context instead of from globals.
+
+## Primitive mapping
+
+| Dynamic workflow | rig | Notes |
+| --- | --- | --- |
+| `export const meta = { name, description, phases, whenToUse }` | `workflow({ meta: { name, description, phases, whenToUse } })` | `phases` accepts `"Title"` or `{ title, detail }`; `meta` may reference variables |
+| `args` (JSON string or object) | `input` schema + `context.input` | Parsed and validated by the launcher; no defensive `JSON.parse` |
+| `await agent(prompt)` | `await call.text(prompt, options?)` | Returns `string \| null` |
+| `await agent(prompt, { schema })` | `await call.json(prompt, schema, options?)` | `schema` is `s.object({ ... })`; result is typed and validated |
+| Reused prompt + schema pair | `agent({ input, output, instructions })` then `call(worker, input, options?)` | Preferred for anything invoked more than once |
+| `parallel(thunks)` | `parallel(thunks)` | Same barrier semantics; failures become `null` holes |
+| `pipeline(items, ...stages)` | `pipeline(items, ...stages)` | Stages receive `(previous, item, index)`; the first stage's `previous` is the item |
+| `phase(title)` | `phase(title)` | Same |
+| `{ phase: "Verify" }` on a call | `{ phase: "Verify" }` in call options | Overrides the ambient phase for that call only |
+| `{ label: "verify:x" }` | `{ label: "verify:x" }` | Appears in `agent_start`/`agent_done` events |
+| `{ model: "sonnet" }` | `{ model: "sonnet" }` | rig passes the id straight to the engine |
+| `{ effort: "high" }` | — | Not modeled; encode importance structurally or in the model id |
+| `{ agentType: "Explore" }` | Prompt wording plus a narrow `tools` list | rig has no built-in read-only agent type |
+| `{ timeoutMs }` / `{ retries }` | `{ timeout }` on the call; `maxTurns` + `repair()` on the agent | rig retries are turn-based, not process-based |
+| `log(message)` | `log(message)` | Same |
+| `budget.total / spent() / remaining()` | `budget.total / spent() / remaining()` | rig meters **agent calls** (`limits.maxAgents`), not tokens |
+| `workflow(ref, args)` | `call.workflow(child, args, options?)` | Shares the limiter, budget, phase, and event stream |
+| top-level `return value` | `return value` from `body` | Same |
+| `Workflow({ scriptPath, args })` from a session | `cat args.json \| node skills/rig/rig.ts program.ts` | See [runtime](runtime.md) |
+
+## Schema conversion
+
+Dynamic workflows pass OpenAI-strict JSON Schema literals. rig schemas are
+`s.*` values that compile to the same JSON Schema, so conversion is mechanical:
+
+| JSON Schema | rig |
+| --- | --- |
+| `{ type: "string" }` | `s.string` |
+| `{ type: "string", description: "d" }` | `s.string("d")` |
+| `{ type: "integer" }` | `s.int` |
+| `{ type: "boolean" }` | `s.boolean` |
+| `{ type: "string", enum: [...] }` | `s.enum("a", "b")` |
+| `{ type: "array", items: X }` | `s.array(X)` |
+| `{ type: "object", properties, required, additionalProperties: false }` | `s.object({ ... })` |
+| `{ anyOf: [X, { type: "null" }] }` | `s.nullable(X)` |
+| omitted from `required` | `s.optional(X)` |
+
+`additionalProperties: false` and a full `required` list are implicit in
+`s.object`, so drop them. Use `s.path` for file paths and `s.url` for URIs.
+
+## Worked conversion
+
+Original dynamic workflow:
+
+```js
+export const meta = {
+  name: 'audit',
+  description: 'Find and verify issues',
+  phases: [{ title: 'Find' }, { title: 'Verify' }],
+}
+
+const FINDINGS = {
+  type: 'object', additionalProperties: false,
+  required: ['findings'],
+  properties: {
+    findings: { type: 'array', items: {
+      type: 'object', additionalProperties: false,
+      required: ['title', 'file'],
+      properties: { title: { type: 'string' }, file: { type: 'string' } },
+    } },
+  },
+}
+
+phase('Find')
+const found = await parallel(args.areas.map((area) => () =>
+  agent(`Audit ${area}. Report findings.`, { label: area, schema: FINDINGS })))
+
+phase('Verify')
+const verified = await pipeline(
+  found.filter(Boolean).flatMap((r) => r.findings),
+  (finding) => agent(`Verify: ${finding.title} in ${finding.file}.`, {
+    phase: 'Verify', schema: VERDICT,
+  }),
+)
+return verified.filter(Boolean).filter((v) => v.real)
+```
+
+Ported to rig:
+
+```ts
+import { s, workflow } from "rig";
+
+const finding = s.object({ title: s.string, file: s.path });
+
+// Workflow role: audit areas in parallel, then verify each finding.
+const audit = workflow({
+  meta: {
+    name: "audit",
+    description: "Find and verify issues",
+    phases: [{ title: "Find" }, { title: "Verify", detail: "one verifier per finding" }],
+  },
+  input: s.object({ areas: s.array(s.string) }),
+  body: async ({ call, input, parallel, phase, pipeline }) => {
+    phase("Find");
+    const found = await parallel(input.areas.map((area) => () =>
+      call.json(`Audit ${area}. Report findings.`, s.object({ findings: s.array(finding) }), { label: area })));
+
+    phase("Verify");
+    const verified = await pipeline(
+      found.flatMap((result) => result?.findings ?? []),
+      (f: { title: string; file: string }) =>
+        call.json(`Verify: ${f.title} in ${f.file}.`, s.object({ real: s.boolean }), { phase: "Verify" }),
+    );
+    return verified.filter((v) => v?.real);
+  },
+});
+
+export default audit;
+```
+
+## Behavior differences to keep in mind
+
+- **Failure holes.** `call` returns `null` when an agent fails, and `parallel`
+  turns rejected thunks into `null`. A rig `pipeline` stage that throws fails the
+  whole run instead of dropping that item to `null`, so programming bugs stay
+  visible; wrap a stage in `try`/`catch` when you want the Claude behavior.
+- **Budget units.** rig counts agent calls, not tokens, so guard loops with
+  `budget.remaining() > n` where `n` is a call count.
+- **Nesting depth.** `call.workflow` has no one-level restriction, but it shares
+  the parent's `maxAgents` and concurrency, so a nested run cannot escape the
+  parent's limits.
+- **No sandbox restrictions.** rig programs are normal TypeScript modules:
+  `Date.now()`, imports, and Node built-ins are allowed, and the launcher owns
+  isolation instead of the runtime.
+- **No resume journal, worktree isolation, or human checkpoints.** These are
+  runtime features of Claude Code, not API surface; a rig workflow that needs a
+  human decision should return a structured `needs_human` result and be re-run
+  with the answer in its input.
+
+## Related references
+
+- [Dynamic workflows](dynamic-workflows.md) — full rig workflow API.
+- [Agent API and schemas](agent-api.md) — `s.*` helpers and call options.
+- [Running and engines](runtime.md) — launching a workflow program.

skills/rig/references/dynamic-workflows.md

@@ -37,8 +37,10 @@ const results = await runWorkflow(audit, {
 });
 ```
 
-`meta` describes the workflow for tools and progress displays. `input` preserves
-Rig schema inference in both `body` and `runWorkflow({ args })`.
+`meta` describes the workflow for tools and progress displays: `name`,
+`description`, optional `phases` (each `"Title"` or `{ title, detail }`), and
+optional `whenToUse`. `input` preserves Rig schema inference in both `body` and
+`runWorkflow({ args })`.
 
 ## Workflow as default export
 
@@ -82,15 +84,33 @@ export default linter;
 | `input` | Typed workflow arguments |
 | `call(worker, input, options?)` | Runs a typed agent; returns its output or `null` on agent failure |
 | `call.text(prompt, options?)` | Runs a one-off string-output agent |
-| `pipeline(items, fn)` | Starts every item immediately; agent calls flow through the shared limiter |
+| `call.json(prompt, schema, options?)` | Runs a one-off agent constrained to `schema`; returns typed output or `null` |
+| `call.workflow(child, args?, options?)` | Runs another workflow inline on the same limiter, budget, and event stream |
+| `pipeline(items, ...stages)` | Streams each item through every stage independently; agent calls flow through the shared limiter |
 | `parallel(thunks)` | Runs all thunks as a barrier and preserves their order |
 | `until(options, step)` | Runs a bounded convergence loop |
 | `phase(name)` | Sets the phase attached to subsequent events |
 | `log(message)` | Emits a structured log event |
+| `budget` | Agent-call meter: `total`, `spent()`, `remaining()` |
 | `signal` | Run cancellation signal for non-agent work |
 
-Call options support `label` plus the normal per-call `model`, `timeout`,
-`maxTurns`, and `signal` overrides.
+Call options support `label` and `phase` (a per-call phase override) plus the
+normal per-call `model`, `timeout`, `maxTurns`, and `signal` overrides.
+
+Each `pipeline` stage receives `(previous, item, index)`. The first stage's
+`previous` is the item itself, so a single-stage pipeline is just
+`pipeline(items, (item) => ...)`. Stages run per item with no barrier between
+them, so one item can be in stage 3 while another is still in stage 1.
+
+`budget` is denominated in agent calls, not tokens: `budget.total` is the
+effective `limits.maxAgents`, `spent()` counts started calls, and `remaining()`
+is what is left before the run fails. Use it to scale depth:
+`while (budget.remaining() > 10) { ... }`.
+
+`call.workflow` runs a child `workflow()` inline. It shares the parent's
+concurrency limiter, agent budget, cancellation signal, and `onEvent` stream, and
+brackets the child with `log` events. Restore a phase after the nested run if the
+child called `phase()`.
 
 `parallel` turns rejected thunks into `null` holes. Agent failures passed through
 `pipeline` are already `null` because `call` handles them; other pipeline callback
@@ -146,3 +166,10 @@ const final = await until(
 
 The loop stops when `done` is true, after `max` rounds, or after
 `noProgressRounds` consecutive equal defined progress keys.
+
+## Porting from Claude dynamic workflows
+
+The rig primitives mirror the Claude Code dynamic-workflow globals (`meta`,
+`args`, `agent`, `parallel`, `pipeline`, `phase`, `log`, `budget`, nested
+`workflow`). See [Converting Claude dynamic workflows to rig](claude-workflow-conversion.md)
+for the full mapping, schema translation table, and behavior differences.

skills/rig/samples/310-workflow-audit-verify.md

@@ -0,0 +1,37 @@
+# 310 - Audit and Verify (Dynamic Workflow Port)
+
+Mirrors a Claude Code dynamic workflow: fan out finders, then stream each finding
+through a verifier stage. See
+[claude-workflow-conversion.md](../references/claude-workflow-conversion.md).
+
+```rig
+import { s, workflow } from "rig";
+
+const finding = s.object({ title: s.string, file: s.path });
+
+// Workflow role: audit source areas in parallel, then verify each finding.
+const audit = workflow({
+  meta: {
+    name: "audit",
+    description: "Find and verify repository issues",
+    phases: [{ title: "Find" }, { title: "Verify", detail: "one verifier per finding" }],
+    whenToUse: "Auditing several areas that each need independent verification.",
+  },
+  body: async ({ call, parallel, phase, pipeline }) => {
+    phase("Find");
+    const areas = ["skills", "src", "scripts"];
+    const found = await parallel(areas.map((area) => () =>
+      call.json(`Audit ${area}/ for risky patterns.`, s.object({ findings: s.array(finding) }), { label: area })));
+
+    phase("Verify");
+    const verdicts = await pipeline(
+      found.flatMap((result) => result?.findings ?? []),
+      (item: { title: string; file: string }) =>
+        call.json(`Verify "${item.title}" in ${item.file}.`, s.object({ real: s.boolean }), { phase: "Verify" }),
+    );
+    return verdicts.filter((verdict) => verdict?.real).length;
+  },
+});
+
+export default audit;
+```