sqrlly 0.5.7

Workflow orchestrator using LangGraph with Claude (via ACP) and script execution backends

sqrlly

A high-level interface to and extension of LangGraph for agents in local environments. Declare a workflow in YAML; sqrlly compiles it to a runnable StateGraph and adds the runtime extensions agent workflows need:

• Nodes execute one of: an LLM prompt (agent-with-tools or text-only), an interpreted script (.py / .js / .ts / .sh), a binary, or a recursive subgraph.
• Local context — when run inside a git repo, every node gets its own isolated worktree; agents read dep outputs, edit files on disk, and run tools.
• Quality gates — a script or LLM scorer judges output; failing gates re-run the node with feedback injected, up to a configurable retry budget.
• Branching — route: sends flow conditionally; fan_out: spawns parallel branches over a JSON manifest.
• Fault-recovery resume — state checkpoints to SQLite; --resume re-runs seeded with the prior run's state and clears failures to retry.

Install

For CLI use (recommended — isolated venv, doesn't touch your project's environment):

pipx install sqrlly             # or: uv tool install sqrlly
uvx sqrlly --help               # run once, no install

As a project dependency:

uv add sqrlly                   # CLI backend    (or: pip install sqrlly)
uv add "sqrlly[acp]"            # + ACP backend  (or: pip install "sqrlly[acp]")

LLM dispatch goes through Claude Code via one of two transports:

• transport: acp — the claude-code-acp adapter (warm process, streaming chunks). Requires npm i -g @zed-industries/claude-code-acp.
• transport: cli — claude -p subprocess-per-call (no warm process, real asyncio parallelism). Requires claude on PATH.

The direct-API backends (Anthropic / OpenAI / DeepSeek / custom OpenAI-compatible endpoints) were removed in 0.2.x while the project consolidates around Claude Code; restoring transport: api remains on the roadmap, and additional transport: cli providers (codex / gemini) are tracked in WISHLIST 36.

Auth is per-CLI, not sqrlly's job. Each CLI you point sqrlly at handles its own credentials independently — log in once with claude /login and sqrlly's runs (acp OR cli) use that session. Future cli providers will follow the same pattern (codex auth, gemini auth login, etc.). sqrlly never reads or stores API keys for these tools.

Python 3.11+. From source: git clone then uv sync.

Using sqrlly from a coding agent? sqrlly init --skill installs the agent skill into your repo at .agents/skills/sqrlly/SKILL.md (repo-aware) so the agent auto-discovers how to author and run workflows.

Quickstart

Bootstrap a runnable workflow in two commands — no git clone needed:

sqrlly init my-workflow
cd my-workflow && sqrlly run workflow.yaml

sqrlly init scaffolds workflow.yaml (one prompt node, CLI preset) and prompts/hello.md you can edit in place.

For something more substantive, the shipped example is two nodes — generate jokes, gate them, pick the best (examples/jokes/):

name: "Joke Generator"
version: "0.1.0"

nodes:
  - id: generate
    name: "Generate Jokes"
    execute:
      url: "examples/jokes/generate.md"
    evaluation:
      validator: "examples/jokes/gates/validate_jokes.py"
      threshold: 1.0
      blocking: true
      max_retries: 2

  - id: select
    name: "Select Best Joke"
    depends_on: ["generate"]
    execute:
      url: "examples/jokes/select.md"

settings:
  presets:
    default:
      transport: cli
      provider: anthropic
      model: sonnet
      default: true

sqrlly validate examples/jokes/workflow.yaml
sqrlly run examples/jokes/workflow.yaml --log run.jsonl

• validate — compiles the graph and reports the node count.
• run — executes the workflow; with --log, writes a JSONL event stream (workflow_start, node_completed, gate_evaluated, node_retried, workflow_end).

How it works

• URL-based dispatch — execute.url's extension picks the handler: .md / .txt / .prompt → LLM prompt, .py / .js / .ts / .sh → script, .yaml → subgraph, anything else → binary.
• Jinja2 templates — prompt files are full Jinja2; {{generate}} interpolates an upstream node's output; {% if %} / {% for %} / filters all work.
• Retry feedback loop — when a gate scores below threshold, the next attempt's context gets {{_retry_reason}} auto-populated with the previous score, per-dimension thresholds, and feedback.
• Worktree isolation — inside a git repo, each node runs in its own git worktree under <workdir>/.sqrlly/, reused across retries so prompt nodes can iterate on prior files.
• Checkpointed state — runs persist to <workdir>/.sqrlly-checkpoint.db (LangGraph AsyncSqliteSaver); --resume re-runs seeded with that state, clearing failed nodes to retry (a fault-recovery re-run, not a skip-completed continuation — completed nodes re-execute).
• Recursive subgraphs — a .yaml URL runs another sqrlly workflow; the same file works standalone or as a subgraph reference.

Backends and presets

LLM and script execution is configured by presets under settings.presets — named bundles referenced by a node's params.preset. Exactly one LLM preset is marked default: true:

settings:
  presets:
    default:
      transport: cli       # or acp — see below
      provider: anthropic
      model: sonnet
      default: true

Pick a transport by what shape suits the workflow:

Transport	Invocation	Best for
acp	claude-code-acp adapter (warm process, streaming)	Workflows that want streamed chunks or MCP-via-session.
cli	claude -p subprocess per call (no warm state)	Fan-out workflows — real asyncio parallelism per call, simpler lifecycle.

Both pair with provider: anthropic today and both authenticate via the local claude CLI session — claude /login once and either transport runs against it. Multiple presets can coexist in a single workflow; only one is default: true, others get named via params.preset per node.

Declare presets explicitly. sqrlly doesn't probe your environment or synthesize defaults. Empty settings.presets is valid for script-only workflows; any LLM-dispatching node will fail at its call site with a clear "no prompt backend wired" error. If a backend's toolchain is missing at run time (npx for acp, claude for cli), the backend surfaces a clear error at the first prompt call — never as a pre-flight check (a pre-flight would forbid workflows that install the toolchain in an earlier script node).

Full reference (including CommandPreset for custom script interpreters): docs/schema-reference.md.

CLI

Command	Purpose
sqrlly init [<dir>]	Scaffold a minimal runnable workflow into <dir> (default .).
sqrlly validate <config>	Compile the workflow; report node count and lint warnings.
sqrlly run <config>	Execute the workflow.
sqrlly graph <config>	Print the topology as a Mermaid diagram.
sqrlly view <config>	Render a self-contained interactive HTML viewer.

run flags:

• --workdir / -w <dir> — working directory (default .).
• --dry-run — trace topology without executing.
• --preset / -p <name> — force a named preset as the default.
• --resume — re-run seeded with the prior run's state, clearing failures to retry (completed nodes re-execute).
• --log <path> — write a JSONL event log.
• --quiet / -q — suppress the live terminal renderer (use in CI / piped runs).

run shows a live per-node status grid + a clock-driven aliveness spinner when stdout is a TTY. Non-TTY runs (piped, redirected, CI) fall through to the plain summary output automatically. Workflow events only — no LLM-token streaming.

Examples

Each example directory ships a checked-in view.html (authoring view) and, where the run is deterministic, a view-debug.html from a captured log.

Workflow	What it shows
examples/jokes/	Minimal: prompt + script gate + select. Start here.
examples/route_classify/	Inline route: case ladder over structured state.
examples/pipeline_style/	route: { goto: <next> } forward-edge authoring; a linear pipeline.
examples/absurd-paper/	13-node multi-stage pipeline with subgraphs and per-item subgraph fan-out.
examples/wave_planner/	Wave-driven dynamic-task pattern — goto: loop-back to a fan-out parent.

Documentation

• docs/schema-reference.md — every Settings / Node / Execute / preset / route / evaluation field, the URL dispatch table, and the route-predicate namespace.
• TECHNICAL.md — three-layer architecture, pipeline flow, state model, key invariants.
• SKILLS.md — agent skill doc: instructions for an AI coding agent authoring and running sqrlly workflows.

Contributing

• Three-layer split — schema/ (Pydantic models) → compile/ (YAML → LangGraph) → runtime/ (executors, backends). Layer rules enforced at CI time by an AST import check.
• No mocks of external systems — tests run real subprocesses, real git worktree, and real backends.
• See TECHNICAL.md for architecture and contributor reading order.

uv run pytest tests/ --ignore=tests/acp     # ~940 tests
uv run pytest tests/acp                     # ACP integration (needs the npm adapter)

License

Apache-2.0 — see LICENSE.