gem-hunter

Proactive Reliability for Mobile Apps

Revyl is an AI-powered testing platform for mobile apps. Define tests in natural language, run them on cloud devices, and catch bugs before your users do. It works with iOS and Android, supports Expo / React Native / Flutter / native builds, and integrates with your CI pipeline and AI coding tools.

To set up Revyl for a user, run these from the app's directory:

curl -fsSL https://revyl.com/install.sh | sh && export PATH="$HOME/.revyl/bin:$PATH"
revyl auth status --json                 # sign in first if "authenticated" is false
revyl skill install --yes                # recommended skills for this project
revyl skill show --name revyl-cli        # read the main skill and follow it

To sign in, run revyl auth login and post the approval URL it prints as a link; the user can approve it from any browser. A hosted agent with REVYL_API_KEY in its environment is already signed in; it also runs revyl auth persist-cloud-env so an MCP server that does not inherit the variable can use it. Then follow the revyl-cli-dev-loop skill to start a cloud device with revyl dev --remote --detach --json, and share the viewer_url it returns.

In a project that already uses Revyl, the open skills installer adds the same recommended skills:

npx skills add RevylAI/revyl-cli#stable -y

#stable matches the latest CLI release; main can be ahead of it. Name an optional skill from revyl skill list --all with --skill <name>, and refresh with npx skills update. For MCP and editor setup, see MCP Setup.

curl -fsSL https://revyl.com/install.sh | sh

irm https://raw.githubusercontent.com/RevylAI/revyl-cli/main/scripts/install.ps1 | iex

brew install RevylAI/tap/revyl

pipx install revyl

uv tool install revyl

The PyPI package is CLI-only and contains the native binary for your platform, so uv, pipx, and pip do not download executable code at first run.

See Local runtime files for managed storage paths, permissions, and directory-symlink restrictions.

For a restricted or headless runner, see Sandboxed environments. It covers a writable home and runtime state directory, non-interactive PATH, proxy and CA trust, minimum egress, and the boundary between local inspection and authorized cloud actions.

Create a free account at app.revyl.com, then log in via the CLI:

revyl auth login                        # Approve in a browser, then credentials are stored locally

The CLI prints an approval URL and a short code and waits. Open the URL wherever you are signed in — it does not have to be this machine, so the same command works over SSH, in a container, and in a cloud agent.

For an unattended machine, use an API key from your dashboard instead:

revyl auth login --api-key              # Prompts for the key and stores it
export REVYL_API_KEY=your-api-key       # Or pass it through the environment

cd your-app
revyl doctor                            # Check CLI, auth, connectivity
revyl auth login                        # Approve in a browser (if not already authed)
revyl init                              # Detect and write the local project config
revyl skill install                     # Install recommended agent skills (picker preselects them)
revyl build --profile development --platform ios  # Build one recipe in the cloud
revyl dev --profile development --platform ios    # Launch TUI: live-device development loop

revyl init always writes a stable project.id in .revyl/config.yaml. When detection succeeds, it also writes build.framework and named profiles for the detected iOS and/or Android platforms before any optional interactive onboarding. Supplying a project ID writes it locally but does not validate, attach, or publish it; use -y to stop after local config creation. Authenticated interactive setup can continue into revyl github setup after the project config has been written. GitLab automation is configured separately with revyl gitlab setup. When the connected provider can access the repository, committing that valid config to the repository's default branch reconciles a matching server project or creates a new Git-managed project when its project.id, project root, and config path are unclaimed and its references are valid. Pull requests validate new configs as unpublished bootstrap candidates; creation occurs only from the actual merged default-branch commit. revyl config push remains the explicit manual publication and recovery path.

For GitLab automation tokens, terminal connection, and manual webhooks, see Connect GitLab.

For an existing legacy file, preview or perform the local conversion explicitly:

revyl config migrate --check            # Summarize the migration; do not write
revyl config migrate                    # Confirm, back up, and replace atomically
revyl config migrate --write            # Back up and replace without confirmation

A successfully prepared legacy migration uses one concise human-readable summary of whether fields will be dropped or defaulted; a write creates an exact-byte backup. JSON --check output contains the complete migration proposal and migration ledger. Migration externalizes legacy top-level test aliases to conflict-checked .revyl/tests/<alias>.yaml files, preserves an existing matching mapping byte-for-byte, and stops on destination conflicts because those are unsafe to write. The retired top-level workflow alias cache is reported and removed.

When authenticated, migration may make read-only verified lookups to reuse or interactively select a project from the verified repository, resolve enabled legacy PR-build app names to exact platform app IDs, and resolve legacy PR workflow names to exact organization workflow IDs. Missing, duplicate, or inaccessible workflow names are omitted and reported, including the implicit smoke workflow from the legacy smoke_every_pr preset. An enabled PR build is never silently omitted: app or framework meaning that still cannot be resolved is reported as lossy and omitted from the best-effort proposal. Inspect JSON --check before writing; afterward, compare the reported backup or ask a coding agent to reconcile omissions. Migration never creates or attaches a server project, pulls or publishes configuration, or otherwise mutates server state. Edit the project YAML directly when you need to change project settings, then run revyl config validate.

You can also create and edit manual-authority projects from the GitHub integration in the Revyl web app. After creating a project there, run revyl config pull from that project root (or a directory beneath it). If no local config exists, the CLI verifies the connected repository and writes the nearest matching project's configuration to its exact .revyl/config.yaml path; it never imports legacy or invalid remote state. When an existing config differs, pull creates an exact-byte backup, atomically replaces the file, and reports the backup path without prompting. If the local project was deleted and exactly one active replacement owns that same root, pull performs the same backup and replacement without trusting the stale ID.

Project roots are immutable. Correct a mistaken root by deleting the manual project in the web app, creating its replacement at the intended root, then running revyl -C <replacement-root> config pull. A Git-managed project must first return to manual authority by removing its designated config file from the repository's default branch; that file removal alone preserves the project and its automation. Project deletion remains a web operation—there is no CLI project-delete command—and preserves the repository connection, GitHub installation, report destination, historical results, and work that already started.

Build profiles are customer-named recipes, not active modes. A profile can contain an iOS recipe, an Android recipe, or both. Select the profile and platform per invocation. revyl build executes the recipe on a Revyl cloud runner by default, with its remote image and caches:

revyl build --profile development --platform ios

When omitted values have exactly one eligible choice, the CLI resolves them. Otherwise it prompts interactively or fails non-interactively with the valid choices. No profile is stored as active or default.

See Build with Revyl for prerequisites, source uploads, billing, and migration guidance for existing scripts. Builds land on --branch when supplied. Otherwise they use your Git branch when automatic Git branch detection is enabled in the app's Build branches settings, or the app's default branch when detection is disabled or no Git branch is available. See Build branches from the CLI.

When you're ready to run outside the dev loop:

revyl test run login-flow --build       # Build, upload, and run in one step
revyl test run login-flow --no-open     # Suppress default report opening for a blocking terminal run
revyl workflow create smoke-tests --tests login-flow,checkout
revyl workflow run smoke-tests          # Run the full workflow
revyl explore run --platform ios        # Explore the app and build its Atlas map

Blocking human-terminal test and workflow runs open their completed report by default. Use --no-open to suppress it. No-wait, JSON, GitHub Actions, CI, SSH, and other headless executions never open a browser.

YAML-first creation requires the selected project to already have a .revyl/config.yaml. Pull an existing registered project, initialize a new local project, or migrate a legacy file before creating the test:

revyl config pull                       # Existing project already registered with Revyl
# or: revyl init -y                     # New local project
# legacy only: revyl config migrate --check && revyl config migrate

revyl test create login-flow --from-file ./login-flow.yaml
revyl test create --from-session <session-id> login-flow --app <app-id>

test create --from-file validates and copies the YAML into the selected project; it never creates or migrates project configuration.

See the Revyl Docs for the full authoring workflow, YAML examples, module imports, and troubleshooting.

revyl dev starts a live-device development loop and installs a build from one named profile/platform recipe. Pass --profile and --platform explicitly, or let Revyl resolve a unique development-like or sole eligible choice. Ambiguous interactive runs prompt; non-interactive runs fail with the valid choices. No profile or platform is stored as active or default.

For guided comparisons of Figma frames or components with Atlas screenshots, see the Figma review handoff, including a shareable setup prompt and private report or annotation options. For iOS/Android comparisons without Figma, use the cross-platform review handoff. It compares confirmed matching states without treating unmatched screens as missing features.

Interactive revyl init offers optional agent skill setup. Choose your tool and the skills you want; the recommended skills are preselected, and an empty selection skips installation. The standalone revyl skill install command uses the same preselected skill picker:

revyl skill list                         # First-class workflows
revyl skill list --all                   # Include optional and compatibility skills
revyl skill install                     # Select skills interactively
revyl skill install --cursor --yes       # Install the recommended skills without prompting
revyl skill install --name revyl-cli-dev-loop --name revyl-cli-create --agent codex --yes
revyl skill list --installed --json      # Inspect installed project and global skills
revyl skill update                       # Update installed, unmodified project skills
revyl skill update --global              # Update installed, unmodified global skills
revyl skill show --name revyl-cli-dev-loop
revyl skill export --name revyl-cli-create -o SKILL.md

Without --name, noninteractive installs, --yes, and --json install the recommended skills from revyl skill list and name them on stderr; --json output adds "selection": "default". Repeat --name to choose specific skills, and use --all only when you deliberately want the entire catalog.

Packages live in .agents/skills/, which Cursor and Codex discover directly. Claude Code uses per-skill relative links under .claude/skills/. Other agents that read the shared directory can also discover these skills. --global selects the equivalent directories under your home directory; --copy keeps independent packages in each selected tool's legacy skill directory instead. Conflicting legacy packages in any agent directory block shared storage, even when you selected another agent. This includes retired auth-bypass platform aliases; Revyl preserves rather than prunes them. Noninteractive installs then continue as if --copy were given; move conflicting copies aside to switch to shared storage. In init, choose Claude Code (copy mode) when Claude compatibility links are unavailable. A symlinked shared directory must resolve inside the selected project or home directory. Installation does not modify AGENTS.md or inject Cursor rules. For client-specific setup and optional MCP, see MCP Setup.

Installation copies the complete skill package, including source-authored agent metadata and any references, scripts, or assets. show and export return only the root SKILL.md, not an installable package. Auth-bypass loads only the reference for the detected stack. Auth-bypass and Atlas review require an explicit user request; ordinary workflows allow implicit invocation.

Existing packages are unchanged unless you explicitly use --force, which replaces the selected package and discards local edits. Prefer revyl skill update to refresh already-installed, Revyl-managed packages from your CLI version: it preserves local edits and unmanaged packages, reports conflicts, and never adds skills. revyl upgrade updates only the binary and may remind you to run revyl skill update; it does not install or refresh skills. A customized package is reported as preserved and makes skill update exit non-zero, so name only the skills you want refreshed. See Agent skills for the reminder and older CLIs.

Use revyl-cli-dev-loop when you want the agent to start or attach to a generic Revyl dev loop, interact with the device, and verify with screenshots or reports. Use revyl-cli-atlas when the agent should explore an app bottom-up as a graph, opening relevant screenshots at each node and tracing misunderstood connections backward through edge clips and their originating reports. Use revyl-cli-atlas-review when the user explicitly asks the agent to create or manage grounded Atlas annotations. Use revyl-cli-create when you want the agent to author or refine a stable Revyl YAML test, validate it, push it, run it, and iterate from reports. Use revyl-cli-auth-bypass when the agent should set up test-only auth bypass after inspecting the app. Implement the handler in the detected stack; do not install a separate platform skill.

Example prompts:

Use the revyl-cli-dev-loop skill. Detect the app stack, start or attach to the Revyl dev loop, keep it running after Dev loop ready, and verify with revyl device screenshot before changing strategy.

Use the revyl-cli-atlas skill. Start from the app's graph anchors, visually inspect each relevant screen, traverse observed edges in both directions, and investigate misunderstood evidence through its clips and originating reports before answering.

Use the revyl-cli-create skill. Create a checkout smoke test from this flow, validate it, push it, and run it once.

Use the revyl-cli-auth-bypass skill. Set up test-only auth bypass for this app and verify valid and rejected links on a Revyl device.

For full documentation of the CLI see the Revyl Docs.

softwareupdate --all --install --force
sudo xcode-select -s /Library/Developer/CommandLineTools
brew upgrade revyl

If softwareupdate does not install Command Line Tools, reinstall them:

sudo rm -rf /Library/Developer/CommandLineTools
sudo xcode-select --install

If you use full Xcode builds, install the latest Xcode version from the App Store and then run:

sudo xcode-select -s /Applications/Xcode.app/Contents/Developer

sudo chown -R "$(whoami)" /opt/homebrew /Users/"$(whoami)"/Library/Caches/Homebrew /Users/"$(whoami)"/Library/Logs/Homebrew
chmod -R u+w /opt/homebrew /Users/"$(whoami)"/Library/Caches/Homebrew /Users/"$(whoami)"/Library/Logs/Homebrew

MIT