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, catalog, orders, appointments, employees, threads, 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. Sign in once. pxb auth opens your browser to approve it, and keeps the token in your OS keychain.
  2. Say where you are. pxb company use <name> and pxb location use <name> pin the company and location calls act in.
  3. Work. pxb customer list, pxb product update ..., 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 help topic — the CLI and these docs are generated from one source, so they can't disagree.

Install
One-line install, and how to uninstall.
Upgrade
Update pxb to the latest build.
Authenticate
Sign in through the browser, with a code, or with an API client.
Commands
Every command, with what it does.
Resources
Reaching every collection by name, and the verbs each one takes.
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