# Pest Flow

> Executable behaviour specifications for Pest 5.

## Docs

- [Introduction](https://maxiviper117.github.io/pest-flow): Write readable Pest tests as executable behaviour specifications.
- [Quickstart](https://maxiviper117.github.io/pest-flow/quickstart): Install Pest Flow and run your first behaviour scenario with Pest.
- [Core concepts](https://maxiviper117.github.io/pest-flow/concepts): Learn how Pest Flow's feature and scenario DSL maps to Pest tests.
- [DSL and API reference](https://maxiviper117.github.io/pest-flow/api): Function signatures, declaration rules, Pest context, and errors for Pest Flow.
- [Behaviour registry](https://maxiviper117.github.io/pest-flow/registry): Inspect Pest Flow nodes, identifiers, source locations, and runtime timing.
- [JSON export](https://maxiviper117.github.io/pest-flow/json-export): Export a versioned Pest Flow behaviour tree as JSON for external tools.
- [Behaviour viewer](https://maxiviper117.github.io/pest-flow/living-documentation): Generate a static interactive explorer for Pest Flow behaviour.
- [Tags and filtering](https://maxiviper117.github.io/pest-flow/tags): Label behaviour nodes and filter scenarios with Pest groups.
- [Troubleshooting](https://maxiviper117.github.io/pest-flow/troubleshooting): Diagnose installation, declaration, context, and registry timing issues.

## Walkthroughs

- [Walkthroughs](https://maxiviper117.github.io/pest-flow/walkthroughs): Learn Pest Flow by building and inspecting complete feature tests.
- [Build your first scenario](https://maxiviper117.github.io/pest-flow/walkthroughs/first-scenario): Write and run a complete contractor activation scenario with Pest Flow.
- [Inspect the behaviour registry](https://maxiviper117.github.io/pest-flow/walkthroughs/inspect-registry): Walk from a feature to its scenarios and inspect IDs, steps, and source locations.

## Agent resources

- [llms-full.txt](https://maxiviper117.github.io/pest-flow/llms-full.txt): The full Markdown of every page in one file.
- [Page Markdown](https://maxiviper117.github.io/pest-flow/index.md): Append `.md` to any page URL to fetch that page as raw Markdown.
- [JSON API](https://maxiviper117.github.io/pest-flow/api/docs/pages.json): Page index of the JSON docs API; each entry links the page's JSON and Markdown forms. Described by the OpenAPI document at https://maxiviper117.github.io/pest-flow/openapi.json.
- [API catalog](https://maxiviper117.github.io/pest-flow/.well-known/api-catalog): RFC 9727 linkset of the APIs documented here.
- [AI catalog](https://maxiviper117.github.io/pest-flow/.well-known/ai-catalog.json): ARD manifest of the agent-facing resources on this site (MCP server, skills, APIs).
- [agent-readability.json](https://maxiviper117.github.io/pest-flow/agent-readability.json): Manifest of every agent-facing artifact on this site.
- [Sitemap](https://maxiviper117.github.io/pest-flow/sitemap.xml): Every indexable page URL with its last-modified date.