>_ RESTERM
v1.10.2
resterm.md

docs Reference

Examples

Ready-to-run request files in the _examples directory.

Explore _examples/ for ready-to-run:

  • basic.http - simple GET/POST with bearer auth.
  • mocks.http - mock routes, variants, matchers, selectors, latency, and fixture bodies.
  • scopes.http - demonstrates global/file/request captures.
  • scripts.http - pre-request and test scripting patterns.
  • xml.http - XML bodies and explicit inline angle-prefixed text.
  • graphql.http - inline and file-based GraphQL requests.
  • grpc.http - gRPC reflection and descriptor usage.
  • k8s.http - Kubernetes profile scopes, non-pod targets, named ports, and gRPC over @k8s.
  • auth_scopes.http - default auth inheritance across global/file/request scopes plus @auth none.
  • auth_command.http - command-backed auth with file-scoped defaults, named definitions with use=, gh auth token, patch-based reuse, JSON output parsing, and custom header examples.
  • oauth2.http - manual capture vs using the @auth oauth2 directive.
  • transport.http - timeout, proxy, and @no-log samples.
  • compare.http - demonstrates @compare directives and CLI-triggered multi-environment sweeps.
  • workflows.http - end-to-end workflow with captures, overrides, and expectations.
  • curl-import.http - sample output generated from curl commands via the CLI importer.

Open one in Resterm, switch to the appropriate environment (resterm.env.json), and send requests to see each feature in action.

Search

↑↓ moveEnter openEsc close

Help

These keys work like the ones in the TUI.

/
Search the docs (also Ctrl K)
j k
Scroll down and up
g g G
Jump to the top or the bottom
[ ]
Previous and next docs page
g d
Docs index
g h
Home page
t
Switch between dark and light
?
Show this help
Esc
Close a dialog