Help › Guide

The Reqlyn guide

Reqlyn 0.5.1 is not released yet. This help describes it ahead of release.

Reqlyn is an API workbench and a self-hosted "API of APIs". You send requests and learn an API on your own computer. You compose requests to several APIs into one typed operation, and test it there. Then you publish it to a Reqlyn server, where others run it with the server's credentials, call it as a route or an MCP tool, and are told when an upstream API changes under it.

This guide says how to do each thing Reqlyn does, as it is built today. The tutorials walk through five tasks from start to finish against the fixture APIs that come with Reqlyn.

The programs

Program What it is for
reqlyn-desktop The workbench: requests, discovery, operations, connections and checks. Linked to a server, also its Catalog, Runs and administration.
reqlyn The command line. It runs stored operations and Arazzo documents on this computer, replays regression cases, and drives a server (reqlyn remote …).
reqlyn-server The server. It keeps published versions, runs them, and answers the run API, routes and MCP.
reqlyn-agent A private agent. It runs a server's work from inside a network the server cannot reach.
The web client Reqlyn in a browser, served by the server at its address. Sign in through the server's identity provider.

Pages

Start here:

  • Getting started: install Reqlyn, start the fixtures, and find your way around the desktop.

Working on your own computer:

  • Requests: sending requests, saving them, variables, environments, responses and history, and GraphQL, server-sent events, WebSocket and gRPC.
  • Connections: credentials, OAuth, login recipes, certificate authorities, client certificates, proxies and SSH bastions.
  • Discovery: importing curl, HAR, Postman, Insomnia, Bruno and OpenAPI; endpoints and documentation differences; tasks drafted from recordings; the recording proxy, the browser recorder and mocks.
  • Operations: typed inputs, steps, mappings, joins, conditions, loops, pagination, the output contract and limits.
  • Scripts: JavaScript before a step's request and after its response, the sandbox, secrets, and Postman, Insomnia and Bruno scripts translated.
  • Arazzo workflows: the operation's source document, what Reqlyn runs of it, and AsyncAPI message steps over Kafka, MQTT, AMQP, WebSocket and SSE.
  • Testing and recovery: test runs, breakpoints, regression cases, write previews, resume, undo, waiting steps and mocks.
  • Reconciliation checks: two systems' records compared, findings reviewed and fixes planned.
  • Connector packages: signed packages of operations, registries, curated packs, snippets and typed clients.

Working with a server:

  • Using a server: linking the desktop, publishing, environments and activation, the Catalog, runs, schedules, routes, MCP, approvals, members and agents.
  • Encrypted sync: the workspace key, devices, synchronizing through a server or a folder, conflicts, history and recovery.

Reference:

  • Command line: every reqlyn command, exit statuses and environment variables.
  • VS Code: a folder workspace's requests sent, operations run and cases replayed from the editor.
  • Coding agents: Claude Code, Codex, Cursor and OpenCode authoring a workspace through reqlyn mcp, with the reqlyn skill.
  • Reqlyn in CI: the CI image, signed; secrets in a job; the GitHub Action and the GitLab template.
  • Command reference, the server program reference and the HTTP API reference: written by the programs from their own usage and API description, so they say exactly what the programs do.
  • Error codes: what each code a run or the server gives means, and what to do.
  • Security: where secrets are kept, what is masked, and what Reqlyn never does.

Running a server for others to use (installation, settings, backups, the deployment manifest, identity providers, agents) is in DEPLOYMENT.md. The installation key's care is in KEY_RECOVERY.md.

Help inside Reqlyn

  • In the desktop, press F1, or choose the help button in the title bar, to read this guide and the tutorials with nothing fetched, opened where it explains the screen you are on, and in the request and operation editors the part you are on. The small question mark beside a part opens its explanation too. Help's search field finds a page by any word in it.
  • On the command line, reqlyn help <command> prints one command's help with examples, and reqlyn --help the overview of every command.

Help for Reqlyn 0.5.1. All help topics