Documentation

Restish is a CLI for REST-ish HTTP APIs. Start with the browser tour to see the major workflows, then move repeated work into API-aware commands, profiles, filters, pagination, and plugins.

Start Here

• New to Restish: Tour of Restish -> Install -> Shell Setup
• Already have an OpenAPI-described API: Connect to an API -> OpenAPI Reference
• Repeating headers, tokens, or environment URLs: Set Up Profiles -> Authentication
• Extending Restish: Install and Use Plugins -> Plugin Quickstart

Common Workflows

• Make requests with generic HTTP verbs or generated commands.
• Send request bodies with shorthand, stdin, forms, and multipart uploads.
• Shape output with formats, filters, tables, raw bytes, and files.
• Follow pagination and links across collections.
• Stream events from SSE and NDJSON endpoints.
• Troubleshoot behavior with symptom-driven fixes.

Popular Reference

• Example API lists the live api.rest.sh endpoints used throughout the docs.
• Commands maps the top-level command surface.
• Global Flags explains request, output, auth, TLS, pagination, cache, and retry flags.
• Config and Profiles document persistent settings.
• Shorthand and Query Syntax cover structured input and filtering.

Sections

• Getting Started tours the product, then routes first-time and returning users to install, setup, and API connection workflows.
• Guides cover multi-step daily work.
• Recipes give command-first answers to narrow tasks.
• Reference is factual lookup for commands, config, formats, and protocols.
• Plugins separates operator docs from author docs.
• Contributing preserves maintainer workflow and design intent.