> ## Documentation Index
> Fetch the complete documentation index at: https://docs.revyl.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Plugin

> Install the Revyl CLI and sign in so Cursor can run and verify mobile apps on cloud devices

Install the Revyl plugin to get the pinned CLI, sign-in hooks, and device skills
in Cursor. The plugin does not start an MCP server.

## What the plugin adds

* **CLI install**: hooks download a pinned Revyl CLI from the GitHub Release,
  cache it locally, and copy it onto a user PATH directory so `revyl` resolves
  in agent shells.
* **Sign-in**: run `revyl auth login` and approve the printed URL, or set
  optional `REVYL_API_KEY` for unattended agents.
* **Skills and rules**: route mobile run, preview, and verification requests
  to the Revyl CLI.

## Setup

### 1. Install plugin

In Cursor, install a [new plugin](https://cursor.com/docs/plugins) by navigating to the [Revyl Marketplace Plugin](https://cursor.com/marketplace/revyl) and selecting `Add to Cursor`.

The plugin installs the CLI on the first `revyl` command and publishes it to
`~/.revyl/bin` (or `~/.local/bin` when that path already holds a different
CLI). Cloud Agents still need those directories on `PATH`. You do not need a
separate `curl | sh` install.

### 2. Sign in

Pick whichever fits how you run agents. Both end in the same stored credential, and you only need one.

**Browser approval.** Ask the agent to run `revyl auth login` and post the
printed approval URL as a clickable markdown link. Open it, confirm the short
code, and approve. Approval works from any browser.

**Optional API key, for unattended agents.** In Revyl, create a new [API key](https://docs.revyl.com/cli/authentication#getting-an-api-key).

* For Cursor Cloud Agents: in Cursor, create a [Runtime Secret](https://cursor.com/docs/cloud-agent/security-network) called `REVYL_API_KEY` holding that key, then start a fresh agent.
* For Cursor local agents: export `REVYL_API_KEY` in the shell that launches Cursor.

The plugin bridges a real key into the credential store with
`revyl auth persist-cloud-env` and never prints it. A Runtime Secret is the
unattended path, not the only path.

### 3. Allow network traffic

Cursor cloud agents need to be able to communicate with Revyl servers. Depending on the Cursor [Network Access Mode](https://cursor.com/docs/cloud-agent/security-network#access-modes), the following domains need to be allowlisted:

* revyl.com
* \*.revyl.com
* revyl.ai
* \*.revyl.ai
* github.com (CLI download)

### 4. Verify

After installing the plugin, start a new Cursor Agent chat and ask: **"is the Revyl CLI installed, authenticated, and ready?"** The agent should confirm that everything is set up.

### 5. Start using Revyl

Ask Cursor Agent chat: **"Run this app on a Revyl device"** and Cursor will start a Revyl device session.

Optional custom MCP is documented in [MCP setup](/cli/mcp-setup). Use a
literal command such as `revyl` or `/usr/local/bin/revyl`, never `${...}`.
The plugin does not start that server.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.