Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.finalrun.app/llms.txt

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

FinalRun ships as a standalone binary. The one-line installer downloads it, puts it on your PATH, and walks you through Android and iOS host tooling. Once it finishes, you can jump straight to the Quickstart.

​
Install

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

​
What the installer does

  1. Downloads the prebuilt finalrun binary to ~/.finalrun/bin/ and symlinks it to ~/.local/bin/finalrun (or %USERPROFILE%\.finalrun\bin\ on Windows).
  2. Updates your shell rc files (.bashrc, .zshrc, .profile, fish config) so finalrun is on your PATH in new shells.
  3. Downloads the matching runtime tarball into ~/.finalrun/runtime/<version>/.
  4. Prompts you for Android, iOS, or both, then installs scrcpy and/or applesimutils via Homebrew when missing.
  5. Installs the FinalRun AI agent skills via npx skills add (requires Node.js 20+ — skipped with a warning if npx isn’t available).
  6. Runs finalrun doctor to verify host readiness.
  7. Detects existing API keys in your environment and prints next steps.

​
Manual prerequisites

The tooling below isn’t auto-installable — you have to provision it yourself before running local tests on that platform. Cloud-only users can skip this section entirely.
ToolHow to provide
Android SDKInstall via Android Studio or the standalone command-line tools. Set ANDROID_HOME (or ANDROID_SDK_ROOT), or put platform-tools and emulator on your PATH.
adbShips with the Android SDK platform-tools.

​
Verify

The interactive installer runs finalrun doctor for you at the end. To re-check at any time: 
finalrun --help
finalrun doctor
Check a single platform: 
finalrun doctor --platform android
finalrun doctor --platform ios
If finalrun isn’t found, open a new shell — the rc files were updated for new sessions. On Windows, restart your terminal.

​
Set an API key

The fastest way to get started is FinalRun Cloud — sign up, drop in one key, and run. If you’d rather use your own AI provider account, that path works too.

FinalRun Cloud — recommended

Grab a FinalRun Cloud API key at cloud.finalrun.app and set FINALRUN_API_KEY. Managed AI, no provider account needed, and new accounts get $5 of free credits.

Bring your own provider key

Use your own Google, OpenAI, or Anthropic API key (GOOGLE_API_KEY, OPENAI_API_KEY, ANTHROPIC_API_KEY). Standard provider billing applies.

​
Upgrade

finalrun upgrade
Pulls the latest release and replaces the binary and runtime in place.

​
Next steps

Quickstart

Generate, run, and fix your first FinalRun test from your AI coding agent.