Usage Overview

piespector is built around a structured request workflow in the terminal.

Typical workflow

Create or import collections on Home.
Select a request in the sidebar and pin it with e.
Edit the top bar (Method, URL) or move through Info, Auth, Params, Headers, Body, and Settings.
Send with s.
Review the inline response or press v to focus the response panel.
Use / to search requests or history entries.
Use Ctrl+P for page commands such as import, export, rename, move, copy, replay, or env management.
Use History to inspect or replay previous runs.
Use Env to manage named variable sets used by placeholders like {{BASE_URL}}.

Main pages

Home

Home is where most work happens: collections, folders, requests, editing, sending, and responses.

Current request editing includes:

structured auth editing
params and headers
Form-Data
x-www-form-urlencoded
raw bodies including JSON, XML, HTML, and JavaScript
GraphQL
Binary
request-level settings for Verify SSL and Follow Redirects

See Home for the detailed page guide.

Env

Env manages named env sets and variables used by placeholders.

See Env for movement and commands.

History

History lets you search, inspect, and replay recorded request snapshots.

See History for the detailed view model.

Help

Current builds expose help through the command palette’s system Help command. It opens Textual’s help panel for the focused widget and active keybindings.

See Help.

The main keys to remember

Ctrl+P opens the command palette
/ opens workspace search on Home and history search on History
Ctrl+O opens jump mode on Home
e opens or edits the current thing
j / k move up and down
h / l move left and right
s sends the active request on Home
Esc backs out of the current interaction

Search

Search is available on Home and History.

On Home, / opens a search palette over collections, folders, and requests.
On History, / opens a search palette over stored history entries.

Reference docs

Previous
Installation Next
Navigation & Modes