Quickstart

This guide walks you through installing the Marathon Cloud CLI, obtaining an API key, and running your first test suite. If you do not have test binaries to hand, step 3 has prebuilt samples so you can see a run end to end first.

1. Install the CLI

   brew tap malinskiy/tap && brew install malinskiy/tap/marathon-cloud

   Use Homebrew to install the Marathon Cloud CLI on macOS or Linux.

   For other platforms, refer to the CLI installation guide.

2. Obtain an API key

   In the Marathon Cloud console, open the user menu and choose Tokens, then create a token and export it:

   export MARATHON_CLOUD_API_KEY=YOUR_TOKEN

   See API keys for storing it in CI.

3. Prepare your application

   Android

   ./gradlew :app:assembleDebug :app:assembleDebugAndroidTest

   Run the Gradle task to build the debug APK and the test APK.

   iOS

   xcodebuild build-for-testing \
     -workspace YourApp.xcworkspace \
     -scheme YourApp \
     -destination 'generic/platform=iOS Simulator' \
     -derivedDataPath build

   Build for the simulator; Marathon Cloud runs iOS tests on ARM64 simulators, so a device build will not run.

   Sample suite

   Prebuilt binaries from the samples repository, if you want to see a run before wiring up your own project:

   curl -LO https://github.com/MarathonLabs/samples/releases/download/samples-2023.06/sample-app.apk
   curl -LO https://github.com/MarathonLabs/samples/releases/download/samples-2023.06/sample-app-androidTest.apk
   curl -LO https://github.com/MarathonLabs/samples/releases/download/samples-2023.06/sample-ios.zip
   curl -LO https://github.com/MarathonLabs/samples/releases/download/samples-2023.06/sample-iosUITests-Runner.zip

   Use sample-app.apk / sample-app-androidTest.apk in place of the Android paths below, or sample-ios.zip / sample-iosUITests-Runner.zip for iOS.

4. Run your first test

   Android

   marathon-cloud run android \
     --api-key YOUR_API_KEY \
     --application app/build/outputs/apk/debug/app-debug.apk \
     --test-application app/build/outputs/apk/androidTest/debug/app-debug-androidTest.apk

   iOS

   marathon-cloud run ios \
     --api-key YOUR_API_KEY \
     --application build/Build/Products/Debug-iphonesimulator/YourApp.app \
     --test-application build/Build/Products/Debug-iphonesimulator/YourAppUITests-Runner.app

   The CLI uploads the binaries, waits for the run, and streams progress.

5. Read the result

   When the run finishes the CLI prints a link to the report and exits 0 if every test passed or 1 if any failed. Open the link for per-test video, logs, and the Allure report. Add --output ./results to download JUnit XML and artifacts locally.

Next steps

• Learn more about Android setup or iOS setup.
• Configure CI/CD integration for automated testing.
• Explore CLI parameters for advanced configuration.