SUMMARY.md

Table of contents

• What is Maestro?
• GitHub Repo

Getting Started

• Installing Maestro
  • macOS
  • Windows
  • Linux
• Build and Install your App
  • Android
  • iOS
• Run a Sample Flow
• Writing Your First Flow
• Maestro Studio
• Running Flows on CI

Platform Support

• Supported Platforms
• Android - Views
• Android - Jetpack Compose
• iOS - UIKit
• iOS - SwiftUI
• React Native
• Flutter
• Web Views

Examples

• Android contacts flow automation
• Facebook signup flow automation
• Advanced: Wikipedia Android
• Page Object Model

CLI

• Cloud
• Test Suites & Reports
• Tags
• Record Your Flow
• Continuous Mode
• View Hierarchy
• Start Device

API Reference

• Commands
  • addMedia
  • assertVisible
  • assertNotVisible
  • assertTrue
  • assertWithAI
  • assertNoDefectsWithAi
  • back
  • clearKeychain
  • clearState
  • copyTextFrom
  • evalScript
  • eraseText
  • extendedWaitUntil
  • hideKeyboard
  • inputText
  • killApp
  • launchApp
  • openLink
  • pressKey
  • pasteText
  • repeat
  • runFlow
  • runScript
  • scroll
  • scrollUntilVisible
  • setLocation
  • startRecording
  • stopApp
  • stopRecording
  • swipe
  • takeScreenshot
  • tapOn
  • doubleTapOn
  • travel
  • waitForAnimationToEnd
• Common command arguments
• Selectors
• Configuration
  • Workspace configuration
  • Flow configuration
  • AI configuration

Advanced

• Nested Flows
• Wait
• Loops
• Conditions
• Parameters & Constants
• JavaScript
  • Run JavaScript
  • Outputs
  • Logging
  • Access element text
  • Make HTTP requests
  • GraalJS support
  • JavaScript announcement blog
• Specify a Device
• Configure Permissions
• Detect Maestro in your app
• Configure Maestro driver timeout
• onFlowStart / onFlowComplete hooks
• Test in different locales
• Structuring your test suite
• Experimental
  • Maestro WebDriver

Troubleshooting

• Known Issues
• Frequently Asked Questions
• Bug Report
• Rollback Maestro
• Debug Output

Community

• Contributions
• Articles & Tutorials