screenRIG
Sign inGet started

Documentation

Set up screenRIG with ChatGPT Codex

Install the official screenRIG plugin in Codex, connect your screenRIG account, pair a Player, and publish your first screen.

Install the plugin →Pair a Player →

This guide is for Codex, OpenAI’s coding agent, in your own terminal. The plugin installs and runs where an agent can execute commands; an ordinary ChatGPT chat reply alone does not set anything up. To run screenRIG inside ChatGPT, use ChatGPT dots: your dot installs the plugin on its own cloud computer. On your phone, you can also use Meta Muse or Grok Bot. Back to Start.

Get Codex

Codex is OpenAI’s coding agent CLI. Install it on your machine following OpenAI’s Codex documentation. The bundled screenRIG CLI needs Node.js 22.23.4+, 24.22.1+, or 26.12.1+ (excluding 23.x and 25.x); check node --version before you begin.

Install the official plugin

Run these in your terminal, not inside Codex:

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

To confirm it’s registered, run codex plugin list --json. Then start Codex in your project directory. If it was already running, restart it so it loads the plugin.

Create your screenRIG project

Give Codex 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 Codex, and keep the web Player in the foreground.

  2. 02

    Describe the result. Tell Codex 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 Codex 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 Codex 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 Choose an authoring path.