auth
Command reference for parix auth.
parix auth manages the local OAuth session used by the rest of the CLI.
parix auth --helpCommands
| Command | Purpose |
|---|---|
parix auth login | Sign in with OAuth consent and PKCE. |
parix auth status | Show and validate the current authenticated session. |
parix auth logout | Remove the local session file. |
login
parix auth login [options]Options:
| Option | Description |
|---|---|
-b, --base-url <url> | Parix base URL. |
-p, --port <port> | Loopback callback port. |
--prompt <prompt> | OAuth prompt override. Defaults to consent. |
-h, --help | Display command help. |
Examples:
parix auth login
parix auth login --base-url http://localhost:5173
parix auth login --port 49152The login command opens a browser authorization flow. On success, it stores the session at ~/.config/parix/session.json.
status
parix auth status [options]Options:
| Option | Description |
|---|---|
-b, --base-url <url> | Override the stored base URL. |
-h, --help | Display command help. |
Examples:
parix auth status
parix auth status --base-url http://localhost:5173The status command refreshes the access token when needed and prints session details, including the active organization.
logout
parix auth logoutThe logout command removes:
~/.config/parix/session.jsonRun parix auth login again before using parix api, parix database, or parix tb.