--- name: maestro description: >- Maestro is an open-source UI testing framework that drives Android, iOS and web apps from short YAML flows (launchApp, tapOn, assertVisible). Use when the user wants to write mobile UI tests, set up Maestro in CI, debug a flaky flow, or let a coding agent run flows through the Maestro MCP server. For React Native gray-box testing see detox; for code-based cross-platform automation see appium. license: Apache-2.0 compatibility: "Java 17+; macOS, Linux or Windows; Android emulators and devices, iOS Simulators (physical iPhones are not supported), web browsers" metadata: author: terminal-skills version: "1.1.0" category: development tags: "mobile-testing, ui-testing, yaml, ios, android" repository: https://github.com/mobile-dev-inc/maestro --- # Maestro ## Overview Maestro tests an app the way a user sees it: it reads the screen through the platform accessibility layer and taps, types and scrolls by text or id. Flows are plain YAML interpreted at run time (no compile step), the same syntax covers React Native, Flutter, native Android/iOS and web, and built-in waiting removes most manual `sleep` calls. Checked against CLI 2.11.0 (29 September 2026). Pieces to know: the open-source CLI (`maestro test`, `maestro mcp`), Maestro Studio (a free desktop app for building flows visually; the old `maestro studio` command was removed from the CLI in 2.6), Maestro Viewer, and Maestro Cloud (paid parallel runs on hosted devices). ## Instructions ### Install Maestro needs Java 17+ (`java -version`, and `JAVA_HOME` must point to it). ```bash # macOS brew tap mobile-dev-inc/tap brew install mobile-dev-inc/tap/maestro # Linux / CI: download the release zip and check it against the published checksum curl -fsSLO https://github.com/mobile-dev-inc/maestro/releases/download/cli-2.11.0/maestro.zip curl -fsSL https://github.com/mobile-dev-inc/maestro/releases/download/cli-2.11.0/checksums_sha256.txt | sha256sum -c - unzip -q maestro.zip -d "$HOME/.maestro-cli" export PATH="$HOME/.maestro-cli/maestro/bin:$PATH" maestro --version ``` The docs also show an install script (`curl ... get.maestro.mobile.dev | bash`); prefer the package manager or the checksum-verified zip above. On Windows, unzip `maestro.zip` and add its `bin` folder to `PATH`. ### Devices ```bash maestro list-devices # emulators/simulators and connected devices maestro start-device --platform android # create and boot a default emulator maestro start-device --platform ios --device-os iOS-18-2 maestro --device emulator-5554 test flows/login.yaml # pick one device explicitly ``` ### A basic flow The header holds `appId` (Android package or iOS bundle id; for web use `url:` instead). Everything after `---` is a command list. ```yaml # flows/login.yaml appId: com.brightbasket.shop env: EMAIL: ${EMAIL || "qa@brightbasket.dev"} --- - launchApp: clearState: true - tapOn: "Email" - inputText: ${EMAIL} - tapOn: "Password" - inputText: ${PASSWORD} - tapOn: "Log In" - assertVisible: "Welcome back" ``` Pass values with `-e` or export shell variables prefixed `MAESTRO_` (CLI only). Parameters arrive as strings; `env:` in the flow defines constants and defaults. ```bash maestro test -e PASSWORD="$QA_PASSWORD" flows/login.yaml ``` ### Scrolling, conditions and sub-flows ```yaml # flows/checkout.yaml appId: com.brightbasket.shop --- - launchApp - runFlow: # dismiss a popup only if it shows up when: visible: "Allow Notifications" commands: - tapOn: "Not Now" - runFlow: when: platform: Android file: subflows/android-permissions.yaml - tapOn: "Electronics" - scrollUntilVisible: element: "Wireless Headphones" direction: DOWN timeout: 20000 - tapOn: "Wireless Headphones" - tapOn: "Add to Cart" - assertVisible: "Added to cart" - takeScreenshot: cart-added ``` Other useful commands: `assertNotVisible`, `extendedWaitUntil` (custom timeout), `retry`, `repeat`, `swipe`, `back`, `hideKeyboard`, `openLink`, `setPermissions`, `runScript`/`evalScript` (JavaScript), `startRecording`. Selectors accept `text`, `id`, `index`, `point`, relational (`below`, `childOf`) and state (`enabled`, `checked`) matchers; prefer `id` (accessibility identifier) when text is ambiguous or localized. ### Running suites and reports ```bash maestro test flows/ # every flow in a folder maestro test --include-tags=smoke flows/ # tags are set in each flow header maestro test --format junit --output report.xml flows/ # JUNIT or HTML reports maestro test --shard-split 2 flows/ # spread flows over 2 connected devices maestro test --continuous flows/login.yaml # re-run on file change while authoring maestro record --local flows/login.yaml # render an MP4 on your machine ``` Screenshots, logs and `commands.json` land in `~/.maestro/tests` unless `--test-output-dir` is set. A workspace `config.yaml` can set `flows`, tags, `executionOrder` and `onFlowStart`/`onFlowComplete` hooks. ### Maestro MCP for coding agents The MCP server ships inside the CLI, so an agent can inspect a live device, tap, assert and write flows: ```bash claude mcp add maestro -- maestro mcp codex mcp add maestro -- maestro mcp ``` ### CI on GitHub Actions (Android emulator) ```yaml # .github/workflows/maestro.yml name: Maestro E2E on: [pull_request] jobs: maestro: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - uses: actions/setup-java@v4 with: { distribution: temurin, java-version: 17 } - name: Install Maestro 2.11.0 (checksum verified) run: | base=https://github.com/mobile-dev-inc/maestro/releases/download/cli-2.11.0 curl -fsSLO $base/maestro.zip curl -fsSL $base/checksums_sha256.txt | sha256sum -c - unzip -q maestro.zip -d "$HOME/.maestro-cli" echo "$HOME/.maestro-cli/maestro/bin" >> "$GITHUB_PATH" - uses: reactivecircus/android-emulator-runner@v2 with: api-level: 34 script: | adb install app/build/outputs/apk/debug/app-debug.apk maestro test --format junit --output report.xml flows/ env: MAESTRO_PASSWORD: ${{ secrets.QA_PASSWORD }} ``` For hosted devices instead of an emulator use `maestro cloud --app-file app.apk --flows flows/` (needs a Maestro Cloud API key and project id). ## Examples ### Example 1: "Write a login test for our shop app and run it on my emulator" ```bash maestro start-device --platform android maestro test -e PASSWORD="$QA_PASSWORD" flows/login.yaml ``` Result: the console lists each command with a check mark (`Launch app`, `Tap on "Email"`, ..., `Assert that "Welcome back" is visible`) and ends with `Flow Passed`. If the text never appears, the run stops at the failing command and the screenshot and hierarchy dump are in `~/.maestro/tests//`. ### Example 2: "Our checkout test fails on iOS because a permission dialog shows up sometimes" Wrap the dialog handling in a conditional so the flow works whether or not it appears: ```yaml - runFlow: when: visible: "Allow While Using App" commands: - tapOn: "Allow While Using App" ``` Run `maestro --platform ios test flows/checkout.yaml`. The step is skipped when the dialog is absent, so the flow no longer flakes. Alternatively grant permissions up front with `launchApp: { permissions: { all: allow } }`. ## Guidelines - Physical iPhones are not supported (Simulators and Android devices are); the CLI exits early with an explicit message. - Prefer `id` selectors plus accessibility labels in the app (`accessibilityIdentifier` on iOS, `testID`/resource ids on Android and React Native, `Semantics` in Flutter); text selectors break when copy or locale changes. - Do not add `sleep`-style waits: use `assertVisible`, `extendedWaitUntil` or `scrollUntilVisible`, which retry automatically. - Keep secrets out of flows: pass them with `-e` or `MAESTRO_*` variables from CI secrets; never commit real credentials. Use a card number like Stripe's test card only against a sandbox. - `maestro record` without `--local` uploads the capture to Maestro's servers for rendering (a deprecated path); use `--local` for private apps. - `maestro chat` was discontinued; use the MCP server. Parameters are strings, so parse numbers in JavaScript. - Use Detox for gray-box React Native tests, Appium when you need code-level control or physical iOS devices. --- Source attribution: TerminalSkills Original project: https://github.com/TerminalSkills/skills/blob/3bfbf7f76459d89422eddc0e5f572ad0e6c393c9/skills/maestro/SKILL.md License: Apache-2.0 License information: https://www.apache.org/licenses/LICENSE-2.0 Original upstream instructions; downloaded from Mega AI Hub. ## Upstream license notice Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to the Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by the Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding any notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS Copyright 2025 Terminal Skills Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. # Mega AI Hub resource metadata Creator / publisher: TerminalSkills Original project: https://github.com/TerminalSkills/skills/blob/3bfbf7f76459d89422eddc0e5f572ad0e6c393c9/skills/maestro/SKILL.md Attribution basis: Source repository record Fields of work: Development & Engineering Roles: DevOps / SRE, Mobile Developer, QA / Test Engineer Specialties: Mobile, Testing Tools: Maestro Country applicability: Country not specified Classification basis: Source catalog labels Instruction SHA-256: ffdb6402627a89e7ae6bf94935bf578229a02358eb25fb15d0730797214ddbc5