Reference

Factual lookup for Restish commands, flags, config, output, content types, profiles, and plugins.

Reference pages answer exact questions. For workflows, start with guides; for a single task, use recipes.

Command And Flag Reference

Commands maps the top-level command surface.
HTTP Commands covers generic verbs and bare URL method inference.
Global Flags lists shared request, output, auth, TLS, pagination, cache, retry, and config flags.
API Management covers restish api ....
Config Command, Cache Command, Doctor, Shell, and Utilities cover support commands.
OpenAPI covers generated command behavior and Restish OpenAPI extensions.
Edit, Plugin, and Bulk cover larger focused commands.

Data And Configuration Reference

Example API lists live docs fixtures.
Config, Profiles, and Auth describe persistent settings and credentials.
Environment Variables lists env overrides.
Content Types covers request encoding and response decoding.
Output Defaults and Output Formats explain rendering.
Shorthand and Query Syntax cover input and filters.
Embedding covers custom Go CLIs built on Restish.

Plugin Reference

Plugin Command for operator command syntax.
Plugin Manifest for manifest fields.
Plugin Messages for host/plugin protocol families.

Commands

Reference index for Restish built-in commands, generic HTTP verbs, generated API commands, and plugin commands.

Generic HTTP Commands

Reference for Restish generic HTTP verbs and bare-URL method inference.

Global Flags

Reference for flags shared across generic requests, generated API commands, utilities, and plugin-delegated requests.

API Management

Reference for registering APIs, syncing specs, editing config, and inspecting API state.

Config Command

Reference for inspecting, editing, patching, and theming Restish configuration.

Cache Command

Reference for inspecting and clearing the Restish HTTP response cache.

Example API

Canonical api.rest.sh endpoints and commands used throughout the Restish docs.

Doctor Command

Reference for diagnosing Restish configuration, registered APIs, plugins, and runtime state.

OpenAPI Extensions and Generated Commands

Reference for shaping generated Restish commands from OpenAPI documents.

Shell Command

Reference for Restish shell setup and completion commands.

Utility Commands

Reference for smaller Restish utility commands: cert, links, and version.

Config

Reference for Restish configuration files, APIs, profiles, auth, cache, themes, plugins, and precedence.

Profiles

Reference for profile fields, profile selection, auth bindings, TLS settings, and precedence.

Environment Variables

Reference for environment variables that affect config, cache, profiles, editors, terminal behavior, and HTTP transport.

Auth

Reference for Restish auth types, params, OpenAPI security bindings, secret sources, redaction, and inspection commands.

Content Types

Reference for built-in content types, request encoding, response decoding, compression, and content plugins.

Output Formats

Reference for Restish output formats and document-versus-record behavior.

Output Defaults

Reference for default output choices on terminals, redirects, filters, pagination, and streams.

Shorthand

Reference for Restish shorthand request bodies, config patches, stdin patches, file loading, arrays, and scalar values.

Query Syntax

Reference for shorthand response queries, normalized response roots, jq selection, and filter scope.

Bulk Command

Reference for the restish-bulk command plugin.

Edit Command

Fetch a resource, edit it locally, and send it back.

Plugin Command

Install, list, remove, and debug Restish plugins.

Plugin Manifest

Reference for Restish plugin manifest fields.

Plugin Messages

Reference for Restish host/plugin message families.

Embedding Restish in Go

Build a custom Go CLI on top of Restish with custom auth, formats, and bundled API defaults.

Last modified May 20, 2026: feat(docs): generate reference drift checks (5ae21f4)