Getting Started

Tour Restish, install locally, connect APIs, and configure daily-use profiles.

This section is the on-ramp for Restish. Start with the interactive tour when you want the fastest overview of what Restish can do, then use the remaining pages as focused setup tasks when you are ready to run the same workflows locally.

Start Here

Follow the Tour of Restish to try the major workflows in your browser.
Use Install when you are ready to run Restish locally.
Run Shell Setup before using filters, query strings, or shorthand heavily.
Connect to an API when generated commands are useful.
Set Up Profiles for environments, auth, and defaults.

Pages In This Section

Tour of Restish is the interactive overview for new users and the workflow map for returning users.
Install covers managed installs, release archives, containers, source builds, and a quick verification request.
Shell Setup helps your shell pass filters, query strings, and shorthand input to Restish unchanged.
Connect to an API turns an OpenAPI description into generated commands for an API.
Set Up Profiles explains named API environments, auth, and reusable defaults.
Upgrade From v1 covers migration notes for existing Restish users.

Existing v1 Users

If you already have Restish v1 config or plugins, read Upgrade From v1 before editing config. The migration docs are kept out of the new-user happy path, but they are still important for existing setups. The archived v1 docs remain available at rest.sh/v1/.