Integrations with any CI platform
Use the FinalRun CLI to run your tests in the cloud from any CI platform.
Prerequisites
Required Components
FinalRun API Key - Obtain from your FinalRun dashboard
App tag - Obtain from your FinalRun dashboard in Apps Section for the specific app
CI Environment - Any platform supporting shell commands
Platform Requirements
Android
Your APK must be x86-compatible
Built with Gradle:
./gradlew assembleDebug
iOS (Future Support)
Provide a path that points to an x86-compatible
*.appsimulator build directory
2. Run Flows in the cloud
1. Install the Finalrun CLI
First, ensure that the Finalrun CLI is installed on your CI machine:
curl -Ls "https://get-cli.finalrun.app/install.sh" | bash2. Run the Finalrun execute command
finalrun-cli execute --api-key=APIKEY --app APP_TAG=APK_FILE_OR_APP_FILEFinalRun CLI Exit Codes
The finalrun-cli returns standard POSIX exit codes to indicate execution status, making it suitable for CI/CD integration and automated workflows.
Exit Code Reference
Code
Status
Description
Common Scenarios
0
Success
All operations completed successfully
• All tests passed
• No test suites configured (nothing to fail)
1
Test Failure
One or more tests failed
• Test cases failed during execution
• Test execution was aborted by user/system
2
System Error
Configuration or execution error
• API communication failure
• Test execution timeout
• Unknown test status
• Failed to create test run
Last updated