CLI overview

The Pxxl CLI ships with @pxxlapp/pxxl. It uses the same API as the SDK and dashboard.

Install

npm install --global @pxxlapp/pxxl
pxxl login
pxxl whoami

pxxl login saves your API key locally. In CI, set PXXL_API_KEY instead.

string

API key used when --api-key is not provided.

string

Default team for team-scoped commands.

string

default:"https://server.pxxl.app/api/v3"

API base URL. Change this only for a private or local Pxxl installation.

pxxl --help
pxxl projects --help
pxxl deploy --help

Use --json when another program needs to read the result.