Skip to main content
Suites are collections of related flows that help you organize your flows and run them together efficiently. Think of suites as folders that group flows by feature, user journey, or any other logical grouping.

​
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”)
Optional:
  • Description: Additional context about what this suite tests
  • 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.

​
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
Example Auth Instructions: 
Login with test@example.com and password TestPass123
Tap "Sign In"
Wait for the home screen to load

​
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:
  1. Edit your suite
  2. Expand the Advanced dropdown
  3. Add key-value pairs (e.g., TEST_EMAIL = suite-user@example.com)
Flow-level variables can further override suite variables for individual flows. See Variables for the full precedence hierarchy.

​
Adding Flows to a Suite

​
Method 1: Create Flow in Suite

  1. Expand your suite in the Flows page
  2. Click Create Flow inside the suite
  3. Write your flow instructions
  4. The flow is automatically added to the suite

​
Method 2: Add Existing Flows

  1. Expand your suite
  2. Click Add Existing Flows
  3. Check the flows you want to include
  4. Click Add Flows

​
Method 3: Attach from Flow

  1. Click the three dots (⋯) next to any flow
  2. Select Attach to Suite
  3. Check the suites you want to add the flow to
  4. Click Save

​
Managing Suite Contents

​
Reordering Flows

Change the order flows run in:
  1. Expand your suite
  2. Drag and drop flows using the handle icon (⋮⋮)
  3. Release to set the new order
Flows execute in the order they appear in the suite.

​
Removing Flows from Suite

  1. Expand the suite
  2. Click the three dots (⋯) next to the flow
  3. 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.

​
Running a Suite

​
Running All Flows

  1. Find your suite in the Flows page
  2. Click Run Suite
  3. Select your app
  4. Choose target device (iPhone/iPad for iOS)
  5. Click Run Suite
The suite executes as follows:
  1. Auth Instructions run first (if configured)
  2. 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.
Flow 1: 
1. Complete the checkout process
2. Save the order number as a variable called order_number
Flow 2 (runs after Flow 1): 
1. Navigate to order history
2. Search for ${env:order_number}
3. Verify the order appears
Hooks in later flows also have access to these variables via standard environment variable access (e.g., os.environ.get("order_number") in Python).
See Variables for more details and examples of cross-flow data sharing.

​
Best Practices

Set Up Auth InstructionsIf your flows require authentication, use Auth Instructions instead of repeating login steps in every flow.

​
Next Steps