# Maestro documentation

Maestro is the simplest and most effective framework for painless mobile and web UI automation using intuitive YAML flows.

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCbCMt5C3rawmE9oIus7f%2Fuploads%2F7kWqvBIcSqYfGW86X7cZ%2FGoogle%20Maps%20UI%20Test%20Automation%20with%20Maestro%20%E2%80%94%20Full%20YAML%20Tutorial.mp4?alt=media&token=1fbdc79b-cc4f-4603-a0d5-1035d9dc2bc1>" %}

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="image">Cover image</th></tr></thead><tbody><tr><td>What is Maestro?</td><td>Learn what Maestro can do for you when testing applications</td><td><a href="what-is-maestro">what-is-maestro</a></td><td><a href="https://1411608689-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCbCMt5C3rawmE9oIus7f%2Fuploads%2FZCpzK3rSlJ9wyebWV6nP%2Fwhat-is-maestro.png?alt=media&#x26;token=601c9a82-6ef3-4da8-bf92-a632d297fe6b">what-is-maestro.png</a></td></tr><tr><td>QuickStart</td><td>Get up and running with Maestro in just a few minutes</td><td><a href="quickstart">quickstart</a></td><td><a href="https://1411608689-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCbCMt5C3rawmE9oIus7f%2Fuploads%2FhnUTGDE3Vljd5gnZRic0%2Fquick-start.png?alt=media&#x26;token=67d99baf-2a65-4099-b932-0cf4488aad3f">quick-start.png</a></td></tr></tbody></table>

### Maestro Solutions

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="image">Cover image</th></tr></thead><tbody><tr><td><strong>Maestro Studio</strong></td><td>Create tests visually  using the Desktop App for zero-IDE setup and instant device connection</td><td><a href="https://app.gitbook.com/s/eQi66gxHTt2vx4HjhM9V/">Maestro Studio overview</a></td><td><a href="https://1411608689-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCbCMt5C3rawmE9oIus7f%2Fuploads%2FFDf3FdvNFj8XLY7hfB8k%2Fmaestro-studio-option2.png?alt=media&#x26;token=6591b6e5-0ba0-4692-befc-9ac5590777b2">maestro-studio-option2.png</a></td></tr><tr><td><strong>Maestro CLI</strong></td><td>Learn to Install the CLI, manage devices, and run tests from your terminal</td><td><a href="https://app.gitbook.com/s/kq23kwiAeAnHkGJYMGDk/">Maestro CLI overview</a></td><td><a href="https://1411608689-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCbCMt5C3rawmE9oIus7f%2Fuploads%2FX5kL6BuPnM6peyOUgN9P%2Fmaestro-cli-option2.png?alt=media&#x26;token=c030792e-511d-4c68-88a4-69d835280578">maestro-cli-option2.png</a></td></tr><tr><td><strong>Maestro Cloud</strong></td><td>Scale your testing by integrating with CI Platforms like GitHub Actions  to run parallel tests</td><td><a href="https://app.gitbook.com/s/ky7LkNoLfvcORtXOzzBs/readme">Maestro Cloud overview</a></td><td><a href="https://1411608689-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCbCMt5C3rawmE9oIus7f%2Fuploads%2F8DqYewbbiamSZMpLzyNB%2Fmaestro-cloud-option2.png?alt=media&#x26;token=53cf746d-30a9-4bc4-ae13-96763d8dc480">maestro-cloud-option2.png</a></td></tr></tbody></table>

### Learn How to Test Using Maestro

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="image">Cover image</th></tr></thead><tbody><tr><td><i class="fa-1">:1:</i> </td><td><strong>How Maestro works</strong></td><td>Learn about Maestro’s architecture-agnostic approach,  device control, and how flows simulate real human interactions</td><td><a href="how-maestro-works">how-maestro-works</a></td><td></td></tr><tr><td><i class="fa-2">:2:</i> </td><td><strong>Maestro Flows</strong></td><td>Master modular testing with Nested Flows, Loops, Conditions, and Hooks</td><td><a href="https://app.gitbook.com/s/mS3lsb9jRwfRHqddeRXG/">Maestro Flows overview</a></td><td></td></tr><tr><td><i class="fa-3">:3:</i> </td><td><strong>JavaScript</strong></td><td>Use JavaScript to handle complex conditions, data manipulation, and external API interactions</td><td><a href="https://app.gitbook.com/s/mS3lsb9jRwfRHqddeRXG/javascript/javascript-overview">JavaScript overview</a></td><td></td></tr><tr><td><i class="fa-4">:4:</i> </td><td><strong>Manage your workspace</strong> </td><td>Learn to configure global behaviors with <code>config.yaml</code>, organize repository architectures, and manage test execution and analysis.</td><td><a href="https://app.gitbook.com/s/mS3lsb9jRwfRHqddeRXG/workspace-management/workspace-management-overview">Workspace management overview</a></td><td></td></tr></tbody></table>

### Reference and Resources

Explore the technical specifications and community-proven strategies.

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>API Reference</strong></td><td>A complete guide to every Maestro command</td><td><a href="https://app.gitbook.com/s/HqSeOOzxPCLfnK9YzOkb/">Commands overview</a></td></tr><tr><td><strong>Examples</strong></td><td>Proven recipes and real-world examples for you to explore</td><td><a href="https://app.gitbook.com/s/JjfcEdmJ9ojsT3Jtpsi8/">Examples overview</a></td></tr><tr><td><strong>Troubleshooting</strong></td><td>Find answers in the FAQ and review Known Issues</td><td><a href="https://app.gitbook.com/s/htfynyR39703f5pJOF1P/troubleshooting">Troubleshooting</a></td></tr></tbody></table>

### Join the Community

See real workflows from other teams, and join the [Maestro Slack community](https://slack.maestro.dev/) to share and learn best practices.

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="image">Cover image</th></tr></thead><tbody><tr><td><strong>Community Projects</strong></td><td>Discover VSCode extensions, plugins, and wrappers built by the Maestro community</td><td><a href="https://app.gitbook.com/s/htfynyR39703f5pJOF1P/community/community-projects">Community projects</a></td><td><a href="https://1411608689-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCbCMt5C3rawmE9oIus7f%2Fuploads%2FFeO1ZinrxJ3St94kVtyw%2Fcommunity-projects-option2.png?alt=media&#x26;token=abe63894-942a-4754-ab7e-687edd9b4cc9">community-projects-option2.png</a></td></tr><tr><td><strong>Articles</strong></td><td>Explore a list of blog posts, deep dives, and tutorials from industry experts</td><td><a href="https://app.gitbook.com/s/htfynyR39703f5pJOF1P/community/articles">Articles</a></td><td><a href="https://1411608689-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCbCMt5C3rawmE9oIus7f%2Fuploads%2FU535rchuM95tn8oAyBSA%2Farticles-option2%20(1).png?alt=media&#x26;token=2756e539-4324-4219-98c7-22007beb23b1">articles-option2 (1).png</a></td></tr><tr><td><strong>Customer Showcase</strong></td><td>Check how teams like Doccla, Wahed, and Eneco revolutionized their mobile testing</td><td><a href="https://app.gitbook.com/s/htfynyR39703f5pJOF1P/community/showcase">Showcase</a></td><td><a href="https://1411608689-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCbCMt5C3rawmE9oIus7f%2Fuploads%2FjTBtqfKcivEA3sLdiZsN%2Fcustomer-showcase-option2.png?alt=media&#x26;token=e75157be-af2d-446c-afb0-6ba36ae2699b">customer-showcase-option2.png</a></td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.maestro.dev/get-started/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.