# screen-relay

screen-relay streams a Linux desktop to a browser and lets humans and AI agents control it from a CLI and a Node SDK.

This file helps AI agents understand and use this documentation site.

## Documentation Surfaces

- [Docs](https://screen-relay.dev/docs): Documentation section: docs
- [Full documentation context](https://screen-relay.dev/llms.txt): All configured documentation as Markdown
- [Semantic documentation sitemap](https://screen-relay.dev/sitemap.md): High-level documentation map for agent navigation
- Page-level Markdown: append .md or .mdx to a documentation URL

## When to use screen-relay

- Category: Developer tools
- Audience: Developers, AI agents
Common use cases:

- Stream a Linux desktop to a browser
- Control a desktop from an agent
- Run a desktop in a sandbox or container

## API and Auth

- [Documentation site API (OpenAPI)](https://screen-relay.dev/openapi.json): HTTP endpoints of this documentation site itself, not the product API

## Important Links

- [Docs](https://screen-relay.dev/docs)
- [Getting started](https://screen-relay.dev/docs/getting-started)
- [GitHub](https://github.com/vercel-labs/screen-relay)
- [screen-relay source](https://github.com/vercel-labs/screen-relay): Source repository for screen-relay
- [GitHub repository](https://github.com/vercel-labs/screen-relay): Source repository

## Agent Instructions

- Use /sitemap.md to identify the most relevant documentation pages before answering broad questions.
- Use /llms.txt when you need the complete documentation corpus as Markdown context.
- Fetch individual documentation pages with a .md or .mdx extension for focused page-level context.
- Only use product capabilities and integration surfaces that are explicitly listed in this file.
