Standard is free within its monthly allowances. Extra usage is optional. Plans & launch terms →

screenRIGstartDASHBOARD

screenrig.ai/docs/start/claude-code

Read as Markdown →

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, then start it in your project directory. The bundled screenRIG CLI needs Node.js 20.11 or newer; check node --version before you begin.

Install the official plugin

Inside Claude Code, run the marketplace install:

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. Ask Claude Code to confirm the install with claude plugin list --json if you want to see it registered.

Connect your screenRIG account

Ask Claude Code to connect your account. For a new account, it asks for your contact email and runs screenrig agent enroll --email ADDRESS; that is the explicit enrollment step. If you already have a screenRIG account, say so and complete the dashboard approval it requests for screenrig agent connect. Never paste your password, account credentials, or API tokens into the conversation.

Both paths in detail, including the pending-approval resume: Account access.

Before account commands, the bundled CLI must be reachable: follow Run the bundled CLI to put screenrig on PATH for the session.

Pair your Player and publish

  1. Install and launch your Player. On the device driving your screen, open play.screenrig.ai or follow Player downloads & setup. The Player web app (PWA) is the Player available today. Install and launch the web app, then send the pairing code shown there to Claude Code, and keep a browser Player in the foreground while trying it out.
  2. 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. 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 screenrig version fails or an account command reports not_enrolled, walk the When the first run fails table on Start: an empty SCREENRIG_PLUGIN_ROOT means the runtime exported no plugin root, and claude plugin list --json gives you the installed plugin path.

Next

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