Skip to content
apigent shell

apigent shell

A line-oriented REPL for browsing, editing and sending requests, without fullscreen keybindings or terminal key conflicts.

Synopsis

apigent shell [--env <name>] [--request <name>] [--format <auto|json|table>]

apigent shell is for humans. It refuses to start with --no-input or --agent (exit code 2): apigent shell is interactive and cannot run with --no-input or --agent; use apigent run <name> instead.

Every send is recorded like a run, so failures can be inspected with apigent diag.

Shell commands

CommandWhat it does
help [command]Show shell help, or detailed help for one command
list [pattern]List saved requests, optionally filtered by text
open [name]Open a request; without a name, shows a numbered selector
new [name]Start a new draft request
showDisplay the current draft, headers, auth and body
set <field> <value>Set method, url, body, collection, folder or timeout
header add <key> <value> / header remove <key> / header clearManage headers
query add <key> <value> / query remove <key> / query clearManage URL query parameters
auth none / auth basic <user> <pass> / auth bearer <token> / auth apikey [header] <value>Configure auth
env list / env use <name> / env showInspect or switch environments
save [name]Save the current draft
send [key=value ...]Send the current draft; missing variables are prompted for
closeClose the current draft
quitExit the shell

Flags

FlagShortDefaultDescription
--format-fautoResponse output format: auto, json, table
--env-enoneActive environment for this shell session
--request-rnoneOpen a request immediately by name

Aliases

  • sh
  • repl

Examples

Open a request against staging

apigent shell --env staging --request "create-order"

Send with one-off values

apigent> open create-order
apigent[create-order]> send amount=10 currency=USD

Build and save a new request

apigent> new health check
apigent[health check]> set url https://api.example.com/health
apigent[health check*]> send
apigent[health check*]> save

Related commands