CLI
Commands
Every command, with what it does.
| Command | Description |
|---|---|
pxb auth | Store client credentials for this machine |
pxb whoami | Show the client, its scopes, and token expiry |
pxb logout | Forget the stored credentials for a profile |
pxb profiles | List stored profiles (--json to script it) |
pxb token | Print a bearer token, for curl or another tool |
pxb company list | use | current | Switch between companies you hold credentials for |
pxb location list | use | current | clear | Pin the location used by calls that need one |
pxb <resource> list | List 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
| Option | Description |
|---|---|
-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-context | Don't fill in the pinned location |
--json | Print only the response body, no status line |
-h, --help | Show help |
-v, --version | Show the version |
Paths resolve against /api/public/v1, so locations and
/api/public/v1/locations are equivalent.
In your terminal: pxb help commands