Skip to content
FlutterProbe

Quick Start

This guide walks you through writing and running your first FlutterProbe test. It assumes you have already installed the CLI and integrated the Dart agent.

1. Write a Test

Section titled “1. Write a Test”

Create a file tests/smoke/login.probe:

test "user can log in"
  @smoke
  open the app
  wait until "Sign In" appears
  tap "Sign In"
  type "user@example.com" into "Email"
  type "secret123" into "Password"
  tap "Continue"
  see "Dashboard"

2. Validate Syntax

Section titled “2. Validate Syntax”

Before running, lint the file to catch syntax errors:

Terminal window
probe lint tests/smoke/login.probe

3. Run the Test

Section titled “3. Run the Test”

Make sure your app is running on a device or simulator with ProbeAgent enabled, then:

Terminal window
probe test tests/smoke/login.probe --device <UDID-or-serial> -v

Flags:

  • -v enables verbose output
  • --device targets a specific device (use probe device list to find available devices)
  • -y auto-confirms destructive operations and auto-grants permissions

4. Run All Tests

Section titled “4. Run All Tests”
Terminal window
probe test tests/ --device <UDID-or-serial> --timeout 60s -v -y

5. Filter by Tag

Section titled “5. Filter by Tag”
Terminal window
probe test tests/ --tag smoke

6. Generate Reports

Section titled “6. Generate Reports”
Terminal window
# JSON output (for HTML report)
probe test tests/ --format json -o reports/results.json --video


# Generate HTML report
probe report --input reports/results.json -o reports/report.html --open


# JUnit XML (for CI)
probe test tests/ --format junit -o reports/results.xml

7. Watch Mode

Section titled “7. Watch Mode”

Re-run tests automatically when .probe files change:

Terminal window
probe test tests/ --watch
Section titled “What to Read Next”