Setup CLI environment

Use this guide to prepare a workstation for Parix CLI usage.

Requirements

You need:

• Node.js 20 or newer
• npm for global installation
• a Parix account with access to an organization
• browser access for the OAuth login flow

The published package is:

@parix/parix

Install the CLI

Install the CLI globally:

npm install -g @parix/parix

Verify the installed command:

parix --help

Expected command groups:

auth
api
database
tb

Choose a Parix environment

By default, the CLI targets:

https://dev.parix.io

Most commands also accept:

--base-url <url>

For a local web app, use:

parix auth login --base-url http://localhost:5173
parix auth status --base-url http://localhost:5173

You can also set HTX_BASE_URL before the first login:

export HTX_BASE_URL="http://localhost:5173"
parix auth login

The CLI resolves the base URL in this order:

1. --base-url
2. the base URL stored in the local session
3. HTX_BASE_URL
4. https://dev.parix.io

Use --base-url when switching an existing session to another environment.

Verify the session

After login, check the session:

parix auth status

The status output includes the signed-in user, base URL, token expiry, scopes, active organization, member role, and session file path.

Developer checkout

When working on the CLI source checkout, build and run the local command wrapper from /Users/lock/ghq/github.com/parixtech/parix-cli:

bun install
bun run build
bun run cli -- --help

For local development against a local Parix web app:

bun run cli -- auth login --base-url http://localhost:5173
bun run cli -- database list --base-url http://localhost:5173