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.

Use the CLI when you want to:

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

Install

Install the package globally and verify that the command is available:

npm install -g @parix/parix
parix --help

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://dev.parix.io

Use --base-url when you need to target another Parix environment:

parix auth login --base-url http://localhost:5173
parix database list --base-url http://localhost:5173

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.