Skip to content

final-run/finalrun-agent

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

262 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

FinalRun logo

npm version License: Apache-2.0

finalrun.app  •  Blog  •  Cloud Device Waitlist  •  Join Slack Community

Follow us on

FinalRun on X   FinalRun on GitHub   FinalRun on LinkedIn


finalrun-agent is an AI-driven CLI that tests your Android and iOS apps using natural language. You write a plain-English test in YAML, FinalRun launches your app on an emulator or simulator, uses an AI model (Gemini, GPT, or Claude) to see the screen and perform each step — tapping, swiping, typing — and produces a pass/fail report with video and device logs.

Demo

FinalRun demo

Install

curl -fsSL https://raw.githubusercontent.com/final-run/finalrun-agent/main/scripts/install.sh | bash

Sets up Node.js, the CLI, AI coding agent skills, and platform tools. Run finalrun doctor to verify host readiness.

Write and Run Your First Test Using AI Agents

FinalRun ships skills that let your AI coding agent generate tests, validate workspaces, and run tests — all from chat.

Generate tests with /finalrun-generate-test

This skill reads your app's source code, infers the app identity, and generates complete test specs with setup, steps, and expected state — organized by feature folder.

/finalrun-generate-test Generate tests for the authentication feature — cover login with valid credentials, login with wrong password, and logout

The agent will:

  1. Read your source code to understand the UI and infer the app's package name / bundle ID
  2. Set up .finalrun/config.yaml and environment bindings in .finalrun/env/
  3. Propose a test plan with file paths and cleanup strategy for your approval
  4. Generate YAML specs under .finalrun/tests/auth/ and a suite under .finalrun/suites/
  5. Run finalrun check to validate everything

/finalrun-generate-test Add a smoke test that verifies the app launches and the home screen is visible

Run tests with /finalrun-use-cli

Once your tests are generated, use this skill to validate and run them.

/finalrun-use-cli Run the auth tests on Android

API Keys (BYOK — Bring Your Own Key)

FinalRun uses your own AI provider API key to run tests.

echo "GOOGLE_API_KEY=your-key-here" > .env
Provider Environment variable
google/... GOOGLE_API_KEY
openai/... OPENAI_API_KEY
anthropic/... ANTHROPIC_API_KEY

Test runs consume API tokens from your configured provider — standard API billing applies.

Running Tests

finalrun test smoke.yaml --platform android --model google/gemini-3-flash-preview
finalrun suite auth_smoke.yaml --platform android --model google/gemini-3-flash-preview

Documentation

Development

See CONTRIBUTING.md for monorepo structure, build commands, and contributor guidelines.