Documentation

New here? Install Relay and send your first request — about ten minutes end to end.

Install RelaymacOS, Windows and Linux builds, first-run notes and verifying the download.Send your first requestA request, a collection, an environment and a test, in five minutes.Move from Postman or InsomniaBring your collections, environments and pm.* scripts with you.

Beyond the basics

Browser security emulationSee the CORS, credentials and CSP failures your frontend will hit — before it does.Mock serverServe a collection’s saved examples on localhost while the real endpoint is still being built.Cookies from your browserSend with the session you already have in Chrome, Edge, Brave or Firefox.Git-backed workspacesReviewable YAML in your repository, with secrets kept on your machine.relay run in CIThe same requests and test scripts from the terminal, with JUnit and JSON reports.Every protocolHTTP, SSE, GraphQL, gRPC, WebSocket, Socket.IO and MCP in one client.

Reference

Scripting APIThe full pm.* surface for pre-request and test scripts.Relay YAML formatThe public contract for Git-backed workspace files.Keyboard shortcutsEvery default binding, and how to rebind them.TroubleshootingGatekeeper, SmartScreen, proxies, corporate CAs and the other usual suspects.

Conventions

• Cmd/Ctrl means Command on macOS and Ctrl on Windows and Linux.
• Commands prefixed $ run in your terminal. Commands without a prefix run inside Relay, usually from the command palette (Cmd/Ctrl K).
• Screenshots use the light theme unless a guide says otherwise; the dark theme behaves identically.

Need something the docs don’t cover?

Open an issue or start a discussion on GitHub. Reports with steps to reproduce and the version from Settings → About get triaged fastest.