Documentation
The reference for request files, directives, protocols, automation, RestermScript and the CLI. Every page is built from the docs/ directory in the repository.
Getting started
- InstallInstall Resterm with Homebrew, the install scripts, a release binary or Go.
- Quick startWrite a first request file, send it, and bootstrap a project with resterm init.
- UI tourThe panes, key bindings, completions, help and response views of the TUI.
- Workspaces and filesHow Resterm finds request files, and how to send a request without one.
Request files
- Request file anatomySeparators, comments, directives and bodies in .http and .rest files.
- Variables and environmentsEnvironment files, variable scopes, resolution order, dynamic helpers and secrets.
- CapturesStore values from a response and reuse them in later requests.
- AuthenticationStatic tokens, captured tokens, OAuth 2.0 and tokens from CLIs you already use.
- JavaScript hooksJavaScript pre-request and test scripts with @script.
- HTTP transport and settingsBase URLs, timeouts, proxies, TLS and other transport settings.
Protocols
Testing and automation
- WorkflowsChain named requests into steps with @workflow and @step.
- Polling and retriesRepeat a request until a condition holds, or retry it on failure.
- Compare runsSend the same request to several environments and diff the results.
- ProfilingRun a request many times and read its latency percentiles.
- Mock serversServe mock responses defined next to your requests, with matching and sequences.
- Recording trafficPut the Resterm proxy in front of an API and save the traffic as requests or mocks.
- History and diffingBrowse, replay and diff past responses.
Connectivity
RestermScript
- OverviewWhat RestermScript is, when to use it and where it runs.
- LanguageComments, literals, operators, types and error handling.
- StatementsBindings, functions, conditionals, switch and loops.
- Modules and exportsShare logic between request files with .rts modules and @use.
- Standard libraryBuilt-in helpers for text, JSON, lists, time, crypto and more.
- Host objectsThe env, vars, request, response, trace, stream and mock objects.
- DirectivesDirectives that evaluate RestermScript: @apply, @assert, @if, @for-each and others.
- Patterns and limitsCommon patterns, hard limits and the reasons behind the design.
CLI
- OverviewThe command-line entry points, their argument order and shared flags.
- resterm runRun request files without the TUI, for scripts and CI.
- resterm mockServe, reset, clear and verify mock servers from the command line.
- resterm recordRecord application traffic from the command line.
- resterm initCreate a new workspace with starter files.
- resterm collectionExport, import, pack and unpack request bundles.
- resterm historyExport, import, inspect and compact stored history.
- Import curl and OpenAPITurn curl commands and OpenAPI documents into request files.
Reference
- ConfigurationWhere Resterm keeps settings, history and themes, and editor diagnostics.
- ThemingWrite and test your own color theme.
- Collection sharingPackage a workspace as a bundle you can commit and import elsewhere.
- SecurityWhat request files can run, the safety limits, and telemetry.
- CompatibilityWhat stays stable through v1 and what may change.
- ExamplesReady-to-run request files in the _examples directory.
- TroubleshootingFixes for common problems and small tips.