Skip to main content
PARIXDocs

auth

Command reference for parix auth.

parix auth manages the local OAuth session used by the rest of the CLI.

parix auth --help

Commands

CommandPurpose
parix auth loginSign in with OAuth consent and PKCE.
parix auth statusShow and validate the current authenticated session.
parix auth logoutRemove the local session file.

login

parix auth login [options]

Options:

OptionDescription
-b, --base-url <url>Parix base URL.
-p, --port <port>Loopback callback port.
--prompt <prompt>OAuth prompt override. Defaults to consent.
-h, --helpDisplay command help.

Examples:

# Default origin is https://parix.io
parix auth login
parix auth login --port 49152

The login command opens a browser authorization flow. On success, it stores the session at ~/.config/parix/session.json.

status

parix auth status [options]

Options:

OptionDescription
-b, --base-url <url>Override the stored base URL.
-h, --helpDisplay command help.

Examples:

parix auth status

The status command refreshes the access token when needed and prints session details, including the active organization. A base URL override reuses the stored token, so only use --base-url with the same trusted origin you authenticated against.

logout

parix auth logout

The logout command removes:

~/.config/parix/session.json

Run parix auth login again before using parix api, parix database, or parix tb.