Parix CLI

The Parix CLI is the parix command-line tool for signing in to Parix, making authenticated API requests, managing databases, and running TigerBeetle operations against a hosted database. This documentation follows the latest published @parix/cli package.

Use the CLI for developer and operator workflows that can use a local OAuth session:

• inspect the active Parix session
• call the Parix API with the stored OAuth bearer token
• list, create, inspect, or remove databases
• run TigerBeetle reads and intentional writes without opening the Dashboard

Application services should use a scoped API key through the raw gateway or a supported application adapter instead of depending on a user's local CLI session.

Install

Install the package globally and verify the command and version:

npm install -g @parix/cli@latest
parix --version
parix --help

Current release

At the time of writing, @parix/cli@latest resolves to 0.1.9. The documentation intentionally installs @latest rather than pinning every example and assumes the current command surface. Confirm the exact installed version with parix --version when reproducing a workflow, and use the TigerBeetle command reference for available options.

The top-level command groups are:

parix auth
parix api
parix database
parix tb

First run

Sign in before running API, database, or TigerBeetle commands:

parix auth login
parix auth status

The CLI opens a browser-based OAuth flow and stores the local session at:

~/.config/parix/session.json

The default Parix base URL is:

https://parix.io

Commands default to production (https://parix.io). Use PARIX_BASE_URL or --base-url only when you deliberately target a trusted non-default origin. See Setup CLI environment for resolution order and security notes.

Typical usage needs no base URL override:

parix auth login
parix database list

Documentation map

Read these pages in order if you are setting up the CLI for the first time:

• Setup CLI environment
• Authentication
• Database command reference
• TigerBeetle command reference

Use the command reference pages when you already know the workflow and need exact arguments, options, or examples.