Loom documentation
Use this page to pick the shortest path through the docs. Loom is a workflow engine with pointer-first diagnostics, and the documentation is organized around the jobs readers usually need to do next.
Start here
| Goal | Link |
|---|---|
| Run your first workflow (5 min) | Hello Loom |
| Understand the author → validate → run → diagnose loop | How Loom works |
| Diagnose a failing run | Diagnostics ladder |
| Browse the CLI | CLI overview |
Pick your path
- Read What is Loom and Why Loom
- Skim the Diagnostics ladder to see the pointer model in practice
- Confirm the CLI surface in the CLI overview
Adopting Loom in a repo
- Follow Hello Loom for your first successful run
- Learn the workflow format in Syntax v1 and Workflows
- When something fails, use What to share to share the minimal evidence set
Fast routes by task
| If you want to... | Start here |
|---|---|
| Try Loom end to end | Hello Loom |
| Learn the operator model | How Loom works in practice |
| Diagnose a failure quickly | Diagnostics ladder |
| Understand artifact shape | Runtime logs contract |
| Browse command behavior | CLI overview |
Alpha 1 note
- Execution: local-only with
loom run --local - Target:
target: linuxonly in schema v1 - Providers: host and Docker-backed execution today
- Agent integration: see Agent integration for MCP, Cursor skill, and agent-driven workflow setup
Site structure
| Section | What's there |
|---|---|
| Product | What Loom is, why it exists, how it works, roadmap |
| Docs | Getting started, concepts, guides, workflows, troubleshooting |
| Reference | CLI commands, workflow schema, artifact contracts |
| Knowledge Base | FAQs, patterns, and operational playbooks |