Docs/Getting Started

Getting Started

FlowGuard is an AI-powered UAT automation platform that scans your codebase, generates test flows, and verifies every step with AI vision. This guide will get you up and running in under 5 minutes.

What is FlowGuard?

FlowGuard automates User Acceptance Testing by combining three technologies:

  • AI codebase analysis that understands your application's pages, forms, and routes
  • A Playwright-based agent that executes test flows in a real browser
  • Claude AI vision that verifies screenshots at every checkpoint with 99% accuracy

The result: you go from codebase to verified test coverage without writing a single test script.

Quick Start

1

Create your workspace

Sign up at the signup page — pick Free (25 runs/month, no credit card) to get going, or pick Pro / Business if you know what you need. Workspace provisions in ~20 seconds after you click the email verification link.

2

Create an Application

Click “New Application” and provide the name, base URL, and repository URL for your app. FlowGuard uses this information to configure the agent.

3

Scan Your Codebase with the Agent

Install and run the FlowGuard agent in scan mode. The agent analyzes your codebase locally — your code never leaves your machine.

Terminal
1"function">dotnet tool install "flag">--global FlowGuard.Agent
2"function">flowguard "function">scan "flag">--repo ./my-app "flag">--app-id YOUR_APP_ID
4

Accept AI-Generated Flow Proposals

After scanning, FlowGuard generates test flow proposals based on your codebase. Review each proposal in the dashboard and accept, modify, or reject them.

5

Run Flows and Review Results

Execute your flows from the dashboard or via the CLI. The agent runs each step in a real browser, captures screenshots, records API calls, and reports results.

Terminal
1"function">flowguard "function">run "flag">--app-id YOUR_APP_ID "flag">--flow-id FLOW_ID
2"comment"># Or "function">run all flows for an application:
3"function">flowguard "function">run "flag">--app-id YOUR_APP_ID "flag">--all