Skip to main content

Documentation Index

Fetch the complete documentation index at: https://quashbugs.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Get from zero to your first test result in 5 minutes. This guide uses a local Android emulator — the fastest path to a working test with no hardware required.

Before you start

You need:
  • Quash installed on your computer (Download here)
  • Android Studio installed with at least one AVD (Android Virtual Device) configured

Step 1 - Install and log in

Mac:
  1. Download the Quash .dmg file.
  2. Open it, drag Quash to your Applications folder.
  3. Launch Quash. When prompted for Keychain access, enter your computer password and click Always Allow.
Windows:
  1. Download the Quash .exe installer.
  2. Run it and follow the on-screen steps.
  3. If Windows SmartScreen appears, click More info → Run anyway.
Once launched, sign in with your email and password, or click Continue with Google for instant access.

Step 2 - Connect a device

The fastest way to get started is with an Android emulator which does not require physical device or additional setups. Follow the steps below to connect one, or skip to the device type that applies to you. Android Emulator (Fastest)
  1. Open Android Studio and start an emulator from the AVD Manager.
  2. In Quash, click Devices in the left navigation.
  3. Click Scan for Devices. Your running emulator appears in the list.
  4. Click Connect next to it.
Quash automatically installs the Mahoraga agent on the emulator with accessibility permissions pre-configured. No manual setup needed. Your emulator is ready to run tasks. Physical Android Device
  1. Enable Developer Options on your Android device and turn on USB Debugging.
  2. Connect your device to your Mac or Windows machine via USB.
  3. In Quash, click Devices → Scan for Devices. Your device appears in the list.
  4. Click Connect.
  5. Open the Mahoraga app on your device, tap Accessibility Service, and enable it from your device settings.
→ See [Physical Android Devices] for the full walkthrough including bounding box calibration. Physical iOS Device
  1. Ensure prerequisites are complete — iOS component installed in Xcode, Apple Developer account signed in, and Developer Mode enabled on your iPhone.
  2. Connect your iPhone to your Mac via USB and tap Trust when prompted.
  3. Register your device UDID in your Apple Developer account at developer.apple.com.
  4. In Quash, click Devices → Scan for Devices. Your iPhone appears and connects automatically.
→ See [Physical iOS Devices] for the full walkthrough including Apple Developer account setup and troubleshooting. iOS Simulator
  1. Open Xcode on your Mac and go to Open Developer Tool → Simulator to launch a simulator.
  2. In Quash, click Devices → Scan for Devices. Your simulator appears in the list.
  3. Click Connect.
→ See [iOS Simulators] for setup details. Quash Cloud Device
  1. In Quash, click the Profile button in the top right corner.
  2. Select Devices from the left navigation panel.
  3. Under Quash Cloud Device Available, click Connect. A device is assigned to you automatically.
Quash cloud devices come with Mahoraga pre-installed. You get 60 minutes of free usage. If all devices are in use, you will be placed in a queue and notified when one becomes available. → See [Cloud Devices] for full details including screen mirroring and parallel testing.

Step 3 - Add your app

  1. Click Apps in the left navigation.
  2. Click + New App.
  3. Search for your app by name as it appears on the Play Store.
  4. Select it and confirm.
Your app is now configured in Quash. For this quickstart you do not need to upload a build or connect GitHub. Those are for deeper test generation. You can skip them and come back later.
For the full walkthrough, see [Apps]

Step 4 - Run your first task

A task is a single plain English instruction you give to Mahoraga. It is the fastest way to test something right now without setting up a full test suite.
  1. Click Tasks in the left navigation.
  2. Click + New Task.
  3. Select your connected device from the device picker.
  4. Select your app.
  5. Type an instruction in the prompt field. For example:
Open the app, navigate to the login screen, enter a valid email
and password, tap Sign In, and verify the home screen loads.
  1. Click Run.
Mahoraga launches your app on the connected device and starts executing. You can watch it work in real time in the device view panel.

Writing your first task prompt

Task prompts are plain English, but their structure matters. Every good task prompt follows the same shape:
Open the app, navigate to [screen], do [action], and verify [expected outcome].
A few things that make the biggest difference:
  • Name UI elements as they appear in the app. Say “tap the Sign In button” not “tap the button.” Mahoraga uses accessibility labels to find elements — the closer your wording matches the actual UI text, the more reliably it lands.
  • Always end with a verification step. Without it, Mahoraga executes the actions but cannot determine if they succeeded. “Verify the home dashboard loads” is what turns a series of taps into a pass/fail result.
  • Handle interruptions explicitly. If your app shows permission dialogs, onboarding tooltips, or cookie banners, tell Mahoraga what to do: “If a notification permission dialog appears, tap Allow.”
Example prompt to try first:
Open the app, navigate to the login screen, enter a valid email and password,
tap Sign In, and verify the home screen loads.
→ For the complete guide to writing task prompts — including data-driven testing, credential management, and common mistakes — see Task Prompt Guide.

Step 5 - Read the report

When the run finishes, the report opens automatically. Click Reports in the left navigation at any time to find it again. The report shows:
  • Executive Summary — a plain English paragraph written by the AI describing exactly what happened and where it stopped if it didn’t complete
  • Observations — specific findings from the run, flagged behaviours, and recommendations
  • Detailed breakdown — every step the agent took, with screenshots
  • Device recording — a full screen recording of the run you can replay and scrub through
If the run returned Partial Success, open Observations first. This almost always means Mahoraga hit something it could not handle — a CAPTCHA, a permission dialog it was not instructed to dismiss, or a loading screen that timed out.

What’s next

You have run your first test. Here is where to go from here depending on what you want to do next.
GoalWhere to go
Generate many test cases at once from a spec or PRDTest Studio
Set up your app properly — GitHub, builds, credentialsApps
Organise tests into a suite and run them togetherSuites
Connect a physical devicePhysical Devices
Understand how Quash’s AI context system worksMemory

Generating tests in Test Studio

When you are ready to move from running individual tasks to generating full test suites, Test Studio is where you work. The quality of what Recipe generates depends almost entirely on how you prompt it, a vague prompt produces generic tests, a specific one produces tests you can run immediately. Every prompt to Recipe works best when it includes: the feature or flow you are testing, the scenarios you want covered (happy path, sad path, edge cases, validation errors), the expected outcomes for each scenario, and UI element names as they actually appear in the app. Before diving in, read: https://www.youtube.com/watch?v=nuUuKJLiI8Q

Creating and Running a Test Suite

Suites let you run a collection of related test cases together in a single go, with one unified report covering everything. You can build a suite from scratch by importing existing cases from your library or writing new ones on the spot, organise them into groups for readability, and choose between Sequential or Isolated execution depending on whether your cases share state or run independently. For the full step-by-step walkthrough, see Suite Overview. https://www.youtube.com/watch?v=b1jU5EefytY