---
title: Overview
description: screen-relay streams a Linux, macOS, or Windows desktop to a browser and lets people and agents control it from a CLI, a Node SDK, or an HTTP API.
url: "https://screen-relay.dev/docs"
docs_index: /llms.txt
lastUpdated: 2026-11-18
---

> For an index of all documentation, see [/llms.txt](/llms.txt).

screen-relay streams a Linux, macOS, or Windows desktop to your browser. Open the viewer link to see the screen and use it with your mouse and keyboard. An agent can control the same desktop from the `screen-relay` CLI, the Node SDK, or the HTTP and WebSocket API, taking screenshots and sending clicks, keys, and text.

## Quickstart

```sh
npm install -g screen-relay
screen-relay up
```

[Getting started](/docs/getting-started) explains each step.

## How it works

The engine captures the screen, encodes it as H.264 video, and streams it to the viewer. The viewer, or an agent over HTTP or WebSocket, sends input back. To see how the stream adapts to a slow link, read [How streaming works](/docs/how-streaming-works).

## What works where

| Platform                 | Backend                      | Start a desktop      | Details                  |
| ------------------------ | ---------------------------- | -------------------- | ------------------------ |
| Linux                    | `x11` (default) or `wayland` | `screen-relay up -d` | [Linux](/docs/linux)     |
| macOS 12.3 or later      | `macos`                      | `screen-relay up -d` | [macOS](/docs/macos)     |
| Windows 10 or later, x64 | `windows`                    | `screen-relay up -d` | [Windows](/docs/windows) |

## Limits

- Audio, clipboard, IME, relative pointer, and hardware encoding are not supported.
- Three capture failures in a row end the session. `screen-relay logs` shows why.

Control, desktop size, and access rules are covered in [CLI reference](/docs/cli), [Configuration](/docs/configuration), and [Remote access](/docs/remote-access).

## Status

> **Experimental:**
>
> CI installs and checks screen-relay on Debian 13, Ubuntu 24.04 and 26.04, Fedora 44,
> Arch Linux, and Alpine 3.24. screen-relay also ran end to end in a Vercel Sandbox on
> Ubuntu 26.04 (x86_64) and in Docker on Debian 13 (arm64). It has not been
> tested over wide-area links or in long runs.

## Next steps

- [CLI reference](/docs/cli): every command, option, output, and error.
- [SDK](/docs/sdk): control a session from Node.
- [HTTP API](/docs/protocol): endpoints, input events, and the wire format.
- [Agent skills](/docs/agent-skills): give an agent a workflow to follow.
- [Remote access](/docs/remote-access): tunnels, TLS, and tokens.

---

For a semantic overview of all documentation, see [/sitemap.md](/sitemap.md)

For an index of all available documentation, see [/llms.txt](/llms.txt)

For agent-facing discovery, including API and MCP surfaces, see [/agents.md](/agents.md)