CLI

Commands

Every command, with what it does.

CommandDescription
pxb authSign in through the browser (or with an API client)
pxb whoamiShow the sign-in or client, its scopes, and expiry
pxb logoutSign out: end the sign-in and forget the profile
pxb profilesList stored profiles (--json to script it)
pxb tokenPrint a bearer token, for curl or another tool
pxb company list | use | currentSwitch the company you're acting in
pxb location list | use | current | clearPin the location used by calls that need one
pxb <resource>The verbs that resource has, and the scopes they need
pxb <resource> listList a collection, e.g. pxb customer list
pxb <resource> get <id>Read one record
pxb <resource> create -d '{...}'Create one
pxb <resource> update <id> -d '{...}'Change one
pxb <resource> delete <id>Remove one
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 upgradeReplace this binary with the latest build
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-browserPrint the sign-in link instead of opening it (auth only)
--deviceSign in with a code from any device (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