screenRIG
DashboardGet started

Documentation

Set up screenRIG in Claude Code

Install the official screenRIG plugin in Claude Code, connect your screenRIG account, pair a Player, and publish your first screen from the terminal.

Install the plugin →Pair a Player →

Claude Code is Anthropic’s terminal agent. Back to Start.

Get Claude Code

Install Claude Code on your machine following Anthropic’s Claude Code documentation. The bundled screenRIG CLI needs Node.js 22.11 or newer; check node --version before you begin.

Install the official plugin

Run these in your terminal, not inside Claude Code:

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

--scope user installs the plugin for your user across projects. To confirm it’s registered, run claude plugin list --json. Then start Claude Code in your project directory. If it was already running, restart it so it loads the plugin.

Create your screenRIG project

Give Claude Code your actual contact email and use the organization name already provided, or default to Screens. Your agent runs screenrig agent enroll --email ADDRESS --organization "Screens" to create its identity, organization, Screens project and membership, and email you a member invitation. That email is your dashboard login, and nothing waits on it: your agent goes straight on to pairing your screen and making content. Open it whenever you want the dashboard to create a passkey, or sign in with your existing login to add the project. The dashboard shows your projects and lets you switch between them.

To sign this installation in to a project you belong to, use screenrig login: you check the code it shows, then choose the project and its access in the dashboard. Never paste passwords, invitation links, or API tokens into the conversation. See Project access.

Pair your Player and publish

  1. 01

    Install and launch your Player. On the device driving your screen, open play.screenrig.ai/player/ or follow Player downloads & setup. The Player web app (PWA) is the Player. Launch it, send the pairing code it shows to Claude Code, and keep the web Player in the foreground.

  2. 02

    Describe the result. Tell Claude Code what to show, which screen to use, and when. If you want it to use a menu spreadsheet or events calendar, identify the source and approve only the access you want it to have.

  3. 03

    Publish and check. Ask Claude Code to publish with screen publish, request a screenshot to verify the result, and check the physical screen yourself.

Already have a Player code? You can combine the request:

Use screenrig.ai for my lobby screen. My pairing code is [code]. Create a welcome board using my events calendar. Ask me for anything else you need.

If setup stalls

If Claude Code reports an error, ask it to work through the When the first run fails table on Start. The plugin’s skill finds its own CLI, so you don’t need to set anything up by hand.

Next

Back to Start, open the CLI reference, or Compose a still.