reference.md

description	Index of the Sendra reference: request files, assertions, environments, scripting, exit codes, JSON output and the TUI, with a link to each page.

Reference

The full schema and behavior reference for Sendra, split by topic. Start at README.md for a five-minute tour if you haven't sent a request with Sendra yet. This is the lookup material for once you have.

• Request and collection file shape: the fields a request or collection file can have, repeated headers, and authentication (auth: bearer/basic/api_key).
• Running and testing requests: sendra run, sendra test, and how a test run's summary counts requests.
• JSON output: the --json document both subcommands can print, field by field.
• Configuration: .sendra/config.yaml, with headers, timeout, redirects, TLS, proxy, cookie jar.
• Environments and variables: .sendra/environments/*.yaml and {{variable}}/${OS_VAR} substitution.
• Assertions: the assertions: block, including the richer operators (greater_than, matches, not:, and so on).
• Capturing values and chaining requests: the capture: block, and how a value moves from one request's response into a later request's substitution.
• CLI overrides: every flag that changes one invocation without editing a file: -H, --var, --timeout, --insecure, --proxy, --client-cert/--client-key, --cookie-jar.
• Scripting: pre_request/post_request, what each can see, in what order, compiled before anything is sent.
• Exit codes: the one table for the whole binary.
• JSON Schema / editor support: pointing an editor at schema/*.schema.json for autocomplete and inline validation.
• Development: building, testing and linting this repository.
• The interactive TUI: sendra tui, for browsing and running requests, every editable field, multi-collection tabs, run history, environments, search/filter, and the full keybinding reference.

For the reasoning behind a design decision rather than the shape of it, see docs/decisions/.