Examples overview

The repo ships runnable example workflows under examples/. Most can be run with bunx orch run <name> once registered, or directly with bun run examples/<name>/index.ts. Start with steps-tui-demo for the full two-pane experience.

Start here

Example	Demonstrates
steps-tui-demo/	The canonical two-pane walkthrough — every per-step Enter behavior (replay, logs, interactive resume) in one short workflow.
hello-file/	The minimal end-to-end run: one autonomous Claude step writing a file.

Authoring patterns

Example	Demonstrates
codex-and-claude/	The smallest two-runner workflow — a Codex step and a Claude step chained through a shared file, both interactive with autoStop.
compound/	A full compound-engineering cycle: brainstorm → plan → deepen → phase-by-phase execution.
feature-loop/	A loop-with-feedback pattern driven by an ask() step (continue / retry / abort).
file-prompts-demo/	The full file-based prompts surface — promptFile: with run-time vars:, the @/.orch/prompts/ shared-fragment pattern, and loadPrompt() composition. Pair with Typed prompt vars for the compile-time contract.
worktree-demo/	createWorktree() with a postCreate hook.

Step kinds

Example	Demonstrates
ask-demo/	An ask() form — fields, buttons, and the typed result.
command-demo/	The first-class command() step with live stdout/stderr streaming.
command-lazygit/	Wrapping an interactive shell tool (lazygit) as a command step.
command-tick-demo/	Proof of live streaming — a shell loop printing one line per second.

Single-runner flows

Example	Demonstrates
riddle-solver/	A multi-step Claude flow solving a riddle.
riddle-solver-proper/	The CLI-loadable variant (exports a default workflow).
codex-riddle-solver/	The same shape driven by the Codex runner.

Subworkflows

These seven examples pair with the Subworkflows guide.

Example	Demonstrates
feature/	Parent dispatches to one of two subs (simple-feature or complex-feature) based on a typed decide step.
simple-feature/	Typed Args = { prompt: string } sub. Runnable both via orch run simple-feature "..." and as a sub of feature.
complex-feature/	Contrast pair with a longer step chain — same Args shape.
parent/	Cwd-isolation parent — chains a step → runWorkflow(branch-isolated, args) → step and shows the parent's cwd is unchanged after the sub returns.
branch-isolated/	Sub that uses createWorktree({ enter: true }) — the cwd change stays bounded to the sub-frame.
ship-many/	Homogeneous parallel of two distinct subs (ship-a, ship-b). The canonical parallel-of-subs shape under v1's single-invocation rule.
ship-one/	The lightest single-step sub.

Where to go next

• Getting started — run your own first workflow.
• Authoring API reference — the primitives these examples use.