Documentation

Source: docs/README.md · repository commit df39fcf

Use this page as the documentation map. The user documentation is organized by task; historical plans are kept separately and are not a description of the current product.

Start here

• Getting started — install chainq, create a flow, and run it.
• CLI tutorial — learn the edit, run, and cache loop.
• Visual editor guide — build and run a flow on the canvas.
• Agent skill — teach a coding agent to author chainq flows.

Guides

• Common tasks — partial runs, inputs, fan-in, structured output, and sample pinning.
• Troubleshooting — diagnose validation, model, cache, and output problems.

Reference and concepts

• CLI reference — commands, options, output streams, and exit behavior.
• Flow YAML reference — every flow field, node type, and template expression.
• Execution and caching — the item model, dependency graph, cache invalidation, and working directory.

Project documentation

• Documentation maintenance — source-of-truth, style, link, and publishing rules.
• Historical design records — dated implementation context; not user documentation.
• Changelog — released changes.