Help › Guide

Getting started

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

Install

The desktop and the command line come together in one package:

  • Windows 10 and 11: Reqlyn-<version>-x64.msi. It installs for you alone and asks for no administrator. It puts reqlyn-desktop.exe and reqlyn.exe in %LOCALAPPDATA%\Programs\Reqlyn, adds a Start menu entry, and adds that folder to your PATH.
  • Linux x86-64: Reqlyn-<version>-x86_64-linux.tar.gz. Its install.sh puts reqlyn-desktop and reqlyn in ~/.local/bin and adds a menu entry.
  • macOS: no package yet.

The packages are not signed. Check one by its SHA-256 before you run it, against a value you got from whoever built it. INSTALL.md has the details, removal, and how to build the packages.

A server is installed separately: see DEPLOYMENT.md.

From the source

With the Rust toolchain that rust-toolchain.toml names (and, on Windows, the MSVC build tools and the Windows SDK):

cargo run -p reqlyn-desktop
cargo run -p reqlyn-cli -- --help

The first build compiles GPUI and takes a few minutes.

The fixture APIs

Reqlyn comes with small APIs to try things against. They make nothing real and every secret in them is made up. Start them in a terminal of their own:

cargo run -p reqlyn-fixtures

They print where they listen:

Address What is there
http://127.0.0.1:8787 The main fixtures: a device inventory at /devices and /devices/{id}, a compliance API at /compliance/devices/{id}/status and /findings, an IPAM at /ipam/addresses, /echo (answers with what it was sent), /slow (answers after 10 seconds), paged lists under /paged/…, /events (server-sent events), /graphql, /xml/devices, OAuth and login fixtures, and more
https://localhost:8788 The same over HTTPS, signed by an authority made when the fixtures start
https://localhost:8789 The same, for a client presenting the fixture's client certificate only
http://127.0.0.1:8790 A forward proxy that prints what it carries
http://127.0.0.1:8791 A made-up identity provider. It signs in anyone who reaches it. REQLYN_FIXTURES_ISSUER_SIGN_IN names an HTTPS address of the local network that carries to it, such as https://192.168.1.20:8794, where a browser on another computer is sent to sign in
grpc://127.0.0.1:8792 A gRPC service, inventory.Inventory, with reflection
ws://127.0.0.1:8793 A WebSocket echo

The certificate files for the HTTPS fixtures, and two SSH bastions on free ports, are written to the temporary folder; the fixtures print the paths and the bastions' users. The fixture inventory has four devices: 4831 pe01.pitb02-pa, 4832 pe02.pitb02-pa, 4840 cr01.pitb02-pa and 4851 agr01.pitb02-pa.

The desktop

The window has a title bar, an icon rail on the left, a sidebar beside it, the work panel, and a status bar. On the first launch, a walkthrough over the window names the first things to do, each with a way to its screen: send a request, bring in what you have, keep a secret as a credential, make an operation, and share it through a server. Closing it, or following one of its ways, closes it for good; "Show the first-run walkthrough" in the command palette opens it again.

  • Title bar: the workspace's name ("Local workspace", or the linked server's workspace), the field "Search or run a command" that opens the command palette (Ctrl K, Cmd K on macOS), the help button, and the window's controls.
  • Rail: Requests, Discovery, Operations, Connections and Checks; Runs and Catalog appear once a server is linked. Settings and the light or dark switch are at its foot.
  • Sidebar: what belongs to the destination chosen: saved requests and history for Requests, the operation list for Operations, Settings' sections, and so on.
  • Status bar: where things run ("Local engine · this computer", or the linked server) and the look, light or dark.

Shortcuts

Keys Does
Ctrl K Opens or closes the command palette
Ctrl Enter Sends the request in the editor
Ctrl . Cancels the request in flight
Ctrl S Saves the request in the editor
Ctrl N Starts a new request
F1 Opens this guide
Escape Closes an overlay; it never cancels a request or a run

On macOS, Cmd takes Ctrl's place. Every list is one Tab stop: Up and Down move through its rows, Home and End go to the first and last, and Enter or Space opens the row.

The command palette lists every command and every saved request: start typing to narrow it. Among them are "Import a curl command", "Copy as curl" (and Python, Rust, TypeScript), "Explore the GraphQL schema", "Listen to the response as it arrives", "Open as a WebSocket", "Call by gRPC", "Export saved requests", "Switch between light and dark", and "Go to" each destination.

Settings

Settings opens from the gear at the foot of the rail. Its General section holds:

  • JSON bodies open: Formatted or Raw, for a new JSON response.
  • Look: Signal, compact and quiet with one indigo accent, or Blueprint, ink on a grid with hard-edged cards. Each comes in light and dark, switched at the foot of the rail; the status bar names both, such as "Signal · Dark".
  • Mirror folder: a folder where each saved request and operation is also written as a text file (see Discovery).
  • Workspace key: for encrypted sync (see Encrypted sync).
  • Claude assistance: off unless you turn it on with your own key (see Discovery).
  • Reqlyn server: the address and token to link a server, or "Sign in with the browser" (see Using a server).

Linked to a server, Settings also has Agents, Approvals, Members and Audit trail sections.

Where your work is kept

What Where
Requests, operations, variables, history, settings A SQLite database in the data folder: %APPDATA%\Reqlyn on Windows, ~/.local/share/Reqlyn on Linux
Secrets: credentials, secret variables, private keys, the workspace key The operating system's secret store: Windows Credential Manager, or the Secret Service (GNOME Keyring, KWallet) on Linux
Exported response bodies and files The Downloads folder

Removing Reqlyn leaves both the data folder and the secrets. These environment variables change where things go, for trying things apart from your real work:

Variable Changes
REQLYN_DATA_DIR The data folder
REQLYN_SECRET_SERVICE The name secrets are filed under in the secret store (dev.reqlyn.desktop unless set)
REQLYN_EXPORT_DIR Where exports are written in place of Downloads
REQLYN_BROWSER The browser a sign-in opens

Free, and what a license adds

Reqlyn is free for one person, with nothing else held back. Three things need a license from your Converged Innovations account: sync between computers, curated packs, and load tests and fuzzing. Sign in from Settings' Account row (or reqlyn account sign-in): your first sign-in on a computer starts a 30-day trial. Without a license, using one of the three is refused with a sentence that says so; what you already have keeps working, a curated pack you installed among it, and your work stays on this computer.

Next

Help for Reqlyn 0.5.1. All help topics