CLI

Commands

Every command, with what it does.

CommandDescription
pxb authStore client credentials for this machine
pxb whoamiShow the client, its scopes, and token expiry
pxb logoutForget the stored credentials for a profile
pxb profilesList stored profiles (--json to script it)
pxb tokenPrint a bearer token, for curl or another tool
pxb company list | use | currentSwitch between companies you hold credentials for
pxb location list | use | current | clearPin the location used by calls that need one
pxb <resource> listList a collection, e.g. pxb customer list
pxb get <path>GET any endpoint
pxb post | put | patch | delete <path>Call an endpoint with that method
pxb request <METHOD> <path>Any other method
pxb help [topic]This documentation

Options

OptionDescription
-d, --data <json>Request body. @file reads a file, - reads stdin
-q, --query <k=v>Query parameter; repeat for more than one
--profile <name>Use a named profile for this call
--base-url <url>API host to authenticate against (auth only)
--no-contextDon't fill in the pinned location
--jsonPrint only the response body, no status line
-h, --helpShow help
-v, --versionShow the version

Paths resolve against /api/public/v1, so locations and /api/public/v1/locations are equivalent.

In your terminal: pxb help commands