Documentation

Quick start

Install the tool, create a context folder inside your own repository, run a demo and commit your first flow.

/docs/quick-start/

Concepts

Flows, applications and environments: the three things every other page is about, and how they fit together.

/docs/concepts/

The context folder

The one folder everything lives in: its layout, what to commit, and the git panel that pulls, commits and pushes it.

/docs/context/

The flow document

A flow is a document you write like a note, where every step is a cell that runs. The editor, the properties, the prose and the steps.

/docs/flows/

Step blocks

Every key a step block accepts: what to call, what to send, what to assert, and the switches around it.

/docs/step-blocks/

Assertions

The test section of a step: status, body, JavaScript expressions, and asserting against what an earlier step remembered.

/docs/tests/

Passing data between steps

Flow memory: what one step writes, the next one reads.

/docs/memory/

Replacers reference

Every {{ template }} you can use in a flow — random data, dates, ids.

/docs/replacers/

Latent applications (MQTT)

Assert on messages produced asynchronously, out of band.

/docs/latent-applications/

Browser automation (Playwright)

Drive a web application from a flow. Experimental.

/docs/playwright/

Applications

What a step calls: a folder of TypeScript methods that know how to reach a system, documented in place.

/docs/applications/

Documenting an application

The JSDoc blocks of index.ts are the method reference the UI shows and the catalogue the AI writes flows from. How to write them well.

/docs/application-docs/

Environments

One env file per application per environment. Where they live, how to edit them, and how the values reach a colleague or a pipeline without going through git.

/docs/environments/

Test runs

What happens when you press Run, what is kept of it, and how to read the HTML report.

/docs/test-runs/

Command line

Run a flow or a whole view headlessly, feed it the environment variables, and wire it into a CI/CD pipeline.

/docs/cli/

Remote agents

Write the flows here, run them on a machine that can reach the systems under test.

/docs/remote-agents/

Writing flows with AI

Create a flow from a description, rewrite one with the magic wand, and everything around it: providers, keys, what the model is given, and its limits.

/docs/ai/

Organizing flows

Folders, properties and saved views: how a few hundred flows stay findable, and why a view is what a pipeline should run.

/docs/organizing/

Filters and formulas

What a view keeps, and what a formula computes.

/docs/view-expressions/

Jira / Xray

Link a flow to a Test issue, and pull the tests of your projects.

/docs/xray/

SharePoint

Upload the HTML report of a finished test run to a document library.

/docs/sharepoint/

Privacy and what leaves your machine

Exactly which network calls the tool makes, and when.

/docs/privacy/

Troubleshooting

The things that usually go wrong, and what to check first.

/docs/troubleshooting/

Getting more help

The docs online, the examples, the source and the issues.

/docs/support/