# From an idea to a verified screen

> Canonical HTML: https://screenrig.ai/docs

Set up your agent, install the Player, and publish your first content. Then use the references to build, update, and inspect it.

<a id="first-screen"></a>

## Your first screen

1. [Install the official plugin](https://screenrig.ai/docs/start.md) in your agent.
2. [Set up the Player](https://screenrig.ai/docs/players.md) on the screen device.
3. [Ask your agent to publish and verify](https://screenrig.ai/docs/agents.md) a menu, video, dashboard, or application.

Agent-specific setup guides sit under Quickstart:
[Meta Muse](https://screenrig.ai/docs/start/muse.md),
[Grok Bot](https://screenrig.ai/docs/start/grok-bot.md),
[ChatGPT dots](https://screenrig.ai/docs/start/dots.md),
[Claude Code](https://screenrig.ai/docs/start/claude-code.md),
[Hermes](https://screenrig.ai/docs/start/hermes.md),
[ChatGPT Codex](https://screenrig.ai/docs/start/chatgpt.md), and
[Gemini Spark](https://screenrig.ai/docs/start/gemini-spark.md), which runs the
official plugin inside a Spark task rather than a terminal.

To show the tab you are looking at on a screen, use the [browser extension](https://screenrig.ai/docs/browser-extension.md).

To read a scanner, a button or a sensor, or drive a relay or a printer, from an application on a screen, see [hardware an application can use](https://screenrig.ai/docs/hardware.md) and [buttons and relays on GPIO](https://screenrig.ai/docs/gpio.md).

Signage and kiosk infrastructure for AI agents. The official plugin at [github.com/screenrig/plugin](https://github.com/screenrig/plugin) bundles the skill and CLI. Players: the Player web app (PWA), Android on Google Play, Amazon Signage Stick, Apple TV, macOS, iPhone and iPad, Windows, Linux and Raspberry Pi packages, LG webOS Signage, BrightSign, and Samsung Smart Signage (Tizen).

Every plan has unlimited screens, and downloads are free.

<a id="sections"></a>

## Documentation sections

- [Quickstart](https://screenrig.ai/docs/start.md) — Install the official plugin and confirm the bundled CLI is ready.
- [Players](https://screenrig.ai/docs/players.md) — Install a native Player or the Player web app on the device that drives your screen.
- [Agents](https://screenrig.ai/docs/agents.md) — Describe the outcome, publish content, and verify the result.
- [CLI](https://screenrig.ai/docs/cli.md) — Look up commands, parameters, output, revisions, and retries.
- [Compose](https://screenrig.ai/docs/compose.md) — Choose an authoring path: stills, cards, soundtracks and tag filters.
- [SDK](https://screenrig.ai/docs/sdk.md) — Build applications with events, playlist control, and persistent state.

<a id="dashboard"></a>

## Run it from the dashboard

Pair screens, build playlists in the page editor, schedule what plays, approve an agent's changes, watch alerts and logs, and manage people, organizations and ads. [Dashboard](https://screenrig.ai/docs/dashboard.md) is the guide to each page and where it is.

<a id="cards"></a>

## Live cards and synced folders

Add clocks, weather, menus, queues and gauges to a playlist. [Browse the card gallery](https://screenrig.ai/apps) or [read the card reference](https://screenrig.ai/docs/cards) for layouts, themes, properties and live data. A [data source](https://screenrig.ai/docs/sources.md) keeps a card current from a calendar or other outside address, and a [connection](https://screenrig.ai/docs/connections.md) saves one sign-in to Microsoft or Google for room sources, Power BI dashboards and media sync. A [media sync](https://screenrig.ai/docs/cli/media-sync.md#media-sync) keeps a media folder in step with a SharePoint, OneDrive, Dropbox or Google Drive folder, or a Canva design, and a [BI view](https://screenrig.ai/docs/cli/bi.md#bi-views) puts a live Grafana, Power BI, Tableau or web-page dashboard on a screen.

<a id="schedules"></a>

## Schedules from a spreadsheet

Import a spreadsheet of screen codes, file names, and start and end times. [Schedule import](https://screenrig.ai/docs/schedule-import.md) checks every row, names each error by row and column, previews the calendar your screens would follow, and applies all of it or none of it.

<a id="reports"></a>

## Reports and exports

Roll uptime, alerts and publishing up by screen folder or tag, download any report as CSV, XLSX or PDF, hand a sponsor a proof of play, email a report on a schedule and export a whole project. [Reports and exports](https://screenrig.ai/docs/reports.md) lists the reports, the schedules and the export format.

<a id="audit"></a>

## Audit log

See who changed what, when and through which surface, with each changed field before and after. [Audit log](https://screenrig.ai/docs/audit.md) lists what is recorded, the filters, how to verify the chain and how to export it.

<a id="troubleshooting"></a>

## Player status codes

Look up the chip a screen shows or a code `screen show` reports. [Player status codes](https://screenrig.ai/docs/troubleshooting.md) explains each status chip, page failure, update, storage and card code, its usual cause and the command that fixes it.

<a id="organization-sign-in"></a>

## Organization sign-in

Organization admins connect [single sign-on](https://screenrig.ai/docs/single-sign-on.md) with Microsoft Entra ID, Okta, Google Workspace or any OpenID Connect or SAML 2.0 provider, and [provision people and project access](https://screenrig.ai/docs/scim.md) over SCIM.

<a id="permissions"></a>

## Permissions by screen folder

Limit a member or an agent to the screen folders and screens they work on, protect the folders whose screens need a second approver, and reserve campaigns for approvers. [Permissions](https://screenrig.ai/docs/permissions.md) covers the scope, the review rule, who is a member or a guest of an organization, what its admins do, the organization's shared Library and the fix for each refusal.

<a id="advertising"></a>

## Buying or selling ads?

The same account, plugin and dashboard run invitation-only advertising. Sellers opt screens in and invite buyers; buyers need no screen, and a seller can also run direct campaigns for its own advertisers. [Buying and selling setup](https://screenrig.ai/docs/start.md#signage-buying-or-selling) · [Advertising commands](https://screenrig.ai/docs/cli/ads.md#ads) · [Rates and fees](https://screenrig.ai/pricing.md)

<a id="agent-reading"></a>

## Reading this as an agent?

Use the [reference context](https://screenrig.ai/llms-full.txt) for public documentation and pricing; it follows the pages listed above.

The installed plugin's skill is the operating guide. Read the relevant reference for exact parameters, then verify the published result with Player evidence.

<a id="reference"></a>

## Need transport details?

The [generated API reference](https://screenrig.ai/docs/api.md) describes the pinned transport contract and schemas. MCP clients such as Claude, ChatGPT and Grok connect to the [remote MCP server](https://screenrig.ai/docs/mcp.md) with OAuth; it runs the same project tools. [Authentication](https://screenrig.ai/docs/authentication.md) covers how agents sign in, Read only, Propose and Manage, review for agent changes, and revoking access; [service clients](https://screenrig.ai/docs/service-clients.md) give servers and CI jobs their own key or secret. The [origin map](https://screenrig.ai/status.md) explains which service owns each surface. Use the bundled CLI for the customer workflow.
