screenriginstall
path: /docs/install/ · canonical marketplaceview as markdown →

install · exact source

Install the complete ScreenRig bundle.

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

The public Apache-2.0 marketplace is github.com/screenrig/plugin. It contains the skill and pinned CLI.

Claude Code

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 entry's installPath, then run <installPath>/skills/screenrig/scripts/screenrig --json version.

Codex

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 run <source.path>/skills/screenrig/scripts/screenrig --json version.

Cold start and first use

Do not assume screenrig is on PATH; use the package-relative wrapper. It currently requires Node.js 20.11 or newer. The first authenticated operation enrolls automatically, creates one ScreenRig account and permanent credential, stores it with user-only permissions in platform configuration, and resumes the request. The default is $XDG_CONFIG_HOME/screenrig/config.json, %APPDATA%\screenrig\config.json on Windows, or ~/.config/screenrig/config.json.

Remove the stored credential

Run <plugin-root>/skills/screenrig/scripts/screenrig --json auth revoke --yes only after accepting permanent loss of access to the current anonymous account. The server revokes exactly the stored calling credential before the CLI removes local credential and retry state. An empty 204 with private no-store is required. Non-secret API configuration, the account, screens, and content remain; no replacement is issued and the next account-scoped command enrolls a separate new account. A failed or ambiguous request retains local state for an exact safe retry. Do not delete the config first or add an idempotency key.

Browser setup

A user-supplied ScreenRig setup instruction authorizes installation of this canonical plugin and automatic enrollment for that setup. Invoke <plugin-root>/skills/screenrig/scripts/screenrig --json browser setup --code ABC-234. The dash is presentation-only. An unclaimed homepage code lasts 30 minutes; a successful claim gets a fresh ten-minute delivery window.

After it connects: put this dashboard, site, image, or video on the screen.

Inspect it

public sourcesecurity policyraw skillmachine index