# Install ScreenRig

> Canonical HTML: https://screenrig.ai/docs/install/
> Last-reviewed: 2026-08-14

Install ScreenRig, open the Player, then ask your agent: pair screen CODE.

The public, Apache-2.0 marketplace is
[`github.com/screenrig/plugin`](https://github.com/screenrig/plugin). It contains
the ScreenRig skill and a pinned CLI. Do not install a separate global
`screenrig` command.

## Claude Code

```console
claude plugin marketplace add https://github.com/screenrig/plugin.git --scope user
claude plugin install screenrig@screenrig --scope user
claude plugin list --json
```

Read the enabled `screenrig@screenrig` entry's `installPath`, then verify the
package-relative wrapper:

```console
<installPath>/skills/screenrig/scripts/screenrig --json version
```

## Codex

```console
codex plugin marketplace add https://github.com/screenrig/plugin.git --ref main --json
codex plugin add screenrig@screenrig --json
codex plugin list --json
```

Use the installed ScreenRig entry's `source.path`, then verify:

```console
<source.path>/skills/screenrig/scripts/screenrig --json version
```

If the runtime loads the skill into the current session, the skill resolves this
wrapper itself. The explicit lookup above is the same-session cold-start path;
do not assume `screenrig` is on `PATH`. The bundled CLI currently requires
Node.js 20.11 or newer and fails with a clear preflight error when that runtime
is unavailable.

## First use

The first authenticated ScreenRig operation enrolls the agent environment
automatically, creates one ScreenRig account and permanent bearer credential,
stores it with user-only permissions, and resumes the original command. The
default credential file is:

- `$XDG_CONFIG_HOME/screenrig/config.json` when `XDG_CONFIG_HOME` is set;
- `%APPDATA%\screenrig\config.json` on Windows;
- `~/.config/screenrig/config.json` otherwise.

`SCREENRIG_CONFIG` can select another path. Updating or uninstalling the plugin
does not remove this user configuration.

## Remove the stored credential

Run `<plugin-root>/skills/screenrig/scripts/screenrig --json auth revoke --yes`
only after accepting permanent loss of CLI access to the current anonymous
account. Revocation is server-first: the CLI revokes exactly the stored calling
credential and issues no replacement, then atomically removes local credential,
enrollment, and transient authenticated-operation state only after an empty
`204` response with the required private no-store policy. Non-secret API
configuration is preserved. The account, screens, and content remain; the next
account-scoped command enrolls a separate new account.

A failed or ambiguous revocation retains the exact local state. Retry the same
command: the revocation endpoint alone accepts the same cryptographically valid
already-revoked bearer for an idempotent `204`, allowing interrupted local
cleanup to complete safely. Do not delete the config first and do not attach an
idempotency key.

## Browser setup

A user-supplied ScreenRig setup instruction authorizes installation of this
canonical plugin and automatic enrollment for that requested setup. Resolve the
wrapper, then run:

```console
<plugin-root>/skills/screenrig/scripts/screenrig --json browser setup --code ABC-234
```

The dash is presentation-only; `ABC-234` and `ABC234` identify the same code. A
homepage handoff remains unclaimed for 30 minutes. A successful claim starts a
fresh ten-minute protected browser-delivery window. If installation cannot
complete, stop and ask the user for a fresh code rather than guessing another
installation or retrying an expired code.

After connection, continue with content already requested or ask what dashboard,
site, image, or video should appear on the screen.

## Inspect before installing

- [Public plugin source](https://github.com/screenrig/plugin)
- [Security policy](https://github.com/screenrig/plugin/blob/main/SECURITY.md)
- [Bundled skill](https://screenrig.ai/skill/SKILL.md)
- [Product documentation](https://screenrig.ai/docs.md)
- [Machine index](https://screenrig.ai/llms.txt)