AutomatorsDocs
Getting started

Install Flowproof

Install Flowproof, verify the CLI, and choose the guide for the system you need to test.

Flowproof records a natural-language YAML flow once, then replays the resulting trace deterministically with zero LLM calls.

Install

Either package ships the same engine as a native binary. Pick whichever matches the project you are testing:

npx flowproof --version      # no install, no Python
npm install --save-dev flowproof
pip install flowproof

The npm package resolves a platform binary for linux-x64, darwin-x64, darwin-arm64 and win32-x64. On any other platform install from PyPI instead; npx flowproof will say so rather than fail obscurely.

Confirm the installation:

flowproof --version

Choose what to test

GoalStart here
Record and replay a first agent or UI flowRecord and replay
Test an AI agent's model and tool behaviorAgent flows
Drive a browserWeb flows
Test HTTP or SQL without a UIAPI-only flows
Drive Windows, SAP GUI, or CitrixLive application tests
Run several flows with shared setupRun a suite
Configure credentials and model accessSecrets and configuration

Build from source

You need Rust and maturin. Run pip install . from sdk/python to compile and install the engine.

Control update notices

Every command checks at most once a day (cached) whether a newer release exists, and prints a one-line notice to stderr if so, never to stdout, so --json output and scripted use stay clean. Set FLOWPROOF_NO_UPDATE_CHECK (any value) to disable it entirely, e.g. for CI or an air-gapped machine.

On this page