CLI

Command Line Interface

Reference for pxb, the Pixelbase command line interface — install, authenticate, list resources, and drive the API from a script or an agent.

pxb is the command line for the Pixelbase API. Everything a company runs on — locations, customers, catalogue, orders, appointments, employees, support cases, the ledger — is reachable from one command.

It is built for two audiences: developers scripting against the API, and AI agents operating a company without a browser in the loop.

A session has three steps:

  1. Authenticate once. pxb auth stores credentials in your OS keychain.
  2. Say where you are. pxb location use <name> pins the location that calls needing one will use.
  3. Work. pxb customer list, pxb post ..., and so on.

Requires Node 18.17 or newer. The binary is self-contained — no package manager, no dependency tree.

Install

One command. Needs Node 18.17 or newer; everything else is self-contained.

bash
curl -fsSL https://www.pxb.app/cli/install.sh | sh

See the CLI overview for what it's for, or read on for how to use it.

Topics

Every page here is also a pxb helptopic — the CLI and these docs are generated from one source, so they can't disagree.

Install
One-line install, upgrade, and uninstall.
→
Authenticate
Store client credentials and how they are kept.
→
Commands
Every command, with what it does.
→
Resources
Collections you can list, and the scope each needs.
→
Context
Companies, locations, and the ids filled in for you.
→
Output and exit codes
How to parse results and branch on failure.
→
Scopes
What bounds an agent, and how to check at runtime.
→
Configuration
Environment variables and file locations.
→
Errors
What each failure means and what to do about it.
→

For agents

The whole reference is available as one document, in two formats, so an agent can read it in a single fetch rather than crawling these pages.

bash
curl https://www.pxb.app/docs/cli/docs.md
curl https://www.pxb.app/docs/cli/docs.json

pxb help --markdown
pxb help --json