Agent Guide

The primary agent entrypoint is the local companion skill: skills/whipplescript-author/SKILL.md (web link).

Use that file first. It explains the mental model, feature map, canonical patterns, validation loop, and common mistakes. This page exists so the website has the same route.

Authoring Route

1. Read the companion skill.
2. Choose a checked example from Examples.
3. Use Concepts only if terms are unclear.
4. Use Manual to choose between rules, flows, queues, child workflows, package capabilities, timers, and revision proposal patterns.
5. Use Language reference for exact syntax.
6. Use Diagnostics guide when check, dev, or runtime inspection reports an error.
7. Validate with:

whip doctor
whip check workflow.whip
whip --json dev workflow.whip --provider fixture --until idle
whip --json trace <instance> --check

Operating Route

If a workflow already ran, inspect state before editing source:

whip status <instance>
whip effects <instance>
whip runs <instance>
whip --json diagnostics <instance>
whip --json evidence <instance>
whip --json trace <instance> --check

Read Runtime & operations for lifecycle behavior and Providers & packages for provider setup.