What is a Suite?
A Suite is a container that groups multiple flows together. Suites provide:- Organization: Keep related flows together (e.g., “Login Flows”, “Checkout Flows”)
- Batch Execution: Run all flows in a suite with one click
- Shared Authentication: Set up authentication once for all flows in the suite
Creating a Suite
Step 1: Click “Create Suite”
Navigate to the Flows page and click the folder+ icon or Create Suite button.Step 2: Enter Suite Details
Required:- Name: A descriptive name for your suite (e.g., “Authentication Flows”)
- Description: Additional context about what this suite tests
- Suite Context: Extra context the AI agent should keep in mind for every flow in the suite
- Auth Instructions: Shared authentication that runs once before all flows
Step 3: Save
Click Create Suite to save. Your new suite appears in the Flows page.Suite Context
Suite Context is plain-English background that’s injected into the AI agent’s prompt for every flow in the suite — alongside any app-level context. Use it for product knowledge, conventions, or constraints that apply to the entire suite (e.g., “this suite tests the membership signup journey only — ignore marketing banners and cookie prompts”). Unlike Auth Instructions, Suite Context isn’t executed as a flow. It just gives the agent shared situational awareness so each flow doesn’t have to repeat the same background. Example Suite Context:Auth Instructions (Setup Flow)
Auth Instructions are special setup instructions that run once at the beginning of the suite, before any flows execute. This is perfect for:- Logging in with test credentials
- Accepting permissions or completing onboarding steps
- Navigating to a specific section of the app
Benefits of Auth Instructions
- Write once, use many times: All flows in the suite start from an authenticated state
- Faster execution: Authentication happens only once, not before every flow
- Easier maintenance: Update login credentials in one place
Suite Variables
Suite variables let you override environment variables for all flows in the suite. They take precedence over environment-level values, so you can customize configuration per suite without changing your environment settings. How to set them:- Edit your suite
- Expand the Advanced dropdown
- Add key-value pairs (e.g.,
TEST_EMAIL=suite-user@example.com)
Adding Flows to a Suite
Method 1: Create Flow in Suite
- Expand your suite in the Flows page
- Click Create Flow inside the suite
- Write your flow instructions
- The flow is automatically added to the suite
Method 2: Add Existing Flows
- Expand your suite
- Click Add Existing Flows
- Check the flows you want to include
- Click Add Flows
Method 3: Attach from Flow
- Click the three dots (⋯) next to any flow
- Select Attach to Suite
- Check the suites you want to add the flow to
- Click Save
Managing Suite Contents
Reordering Flows
Change the order flows run in:- Expand your suite
- Drag and drop flows using the handle icon (⋮⋮)
- Release to set the new order
Removing Flows from Suite
- Expand the suite
- Click the three dots (⋯) next to the flow
- Select Remove from Suite
Removing a flow from a suite doesn’t delete the flow—it just removes the relationship. The flow remains in your Flows list.
Deleting a Suite
To delete a suite:- Find the suite in the Flows page
- Click the trash icon on the suite card
- Confirm deletion in the dialog
Deleting a suite does not delete the flows inside it. All flows are preserved and remain available in your workspace. Flows that belong to other suites stay attached to those suites.
Running a Suite
Running All Flows
- Find your suite in the Flows page
- Click Run Suite
- Select your app
- Choose target device (iPhone/iPad for iOS)
- Click Run Suite
- Auth Instructions run first (if configured)
- Each flow runs, starting from an authenticated state
Sharing Data Between Flows
When flows run in a suite, runtime variables from one flow automatically carry forward to the next. This includes values exported by hooks, variables set by the agent, and any per-flow or per-suite variable overrides. Use the${env:KEY} syntax in later flow instructions to reference values from earlier flows.
${env:KEY} can only reference values that existed before the agent began running — it cannot reference values saved by the agent or exported by mid-flow hooks during execution. For those, use Get Variable instead.os.environ.get("order_number") in Python).