Why Use the CLI?
- Local-first workflow - Edit tests in your IDE, sync with the cloud
- CI/CD ready - Integrate testing into your build pipelines
- Fast iteration - Run tests directly from your terminal
- Version control - Store test definitions alongside your code
Installation
Install the CLI using your preferred method:On macOS, Homebrew is the recommended installation method. It handles updates automatically via
brew upgrade revyl.Direct download
Download the binary for your platform from GitHub Releases. Available builds:| Platform | Architecture | Asset |
|---|---|---|
| macOS | arm64 (Apple Silicon) | revyl-darwin-arm64 |
| macOS | amd64 (Intel) | revyl-darwin-amd64 |
| Linux | arm64 | revyl-linux-arm64 |
| Linux | amd64 | revyl-linux-amd64 |
| Windows | amd64 | revyl-windows-amd64.exe |
PATH.
Verify Installation
Run Diagnostics
Check that everything is configured correctly:- CLI version and updates
- Authentication status
- API connectivity
- Project configuration
- Build system detection
Quick Start
Get up and running in 5 commands:If you don’t have tests yet, create one in the Revyl dashboard first, then use
revyl test pull to download it locally.Updating the CLI
Use the upgrade command that matches how you installed:revyl upgrade performs a self-update (downloads the latest binary, verifies checksums, and replaces the executable). To check for updates without installing, use:
Global Flags
These flags work with any command:| Flag | Description |
|---|---|
--debug | Enable debug logging |
--dev | Use local development servers |
--json | Output results as JSON |
--quiet, -q | Suppress non-essential output |
Next Steps
For focused device session and action workflows, see Device Automation.Authentication
Set up your API key
Project Setup
Initialize your project
Managing Tests
Sync and manage tests
Running Tests
Execute tests locally
Dev Loop
Iterate quickly with revyl dev
Device Automation
Start, control, and debug cloud devices