Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/groniz/groniz-cli/llms.txt

Use this file to discover all available pages before exploring further.

The groniz auth command group handles authentication with the Groniz platform. Use auth login to start an OAuth2 device flow and store credentials locally, auth logout to remove them, and whoami to confirm which account the CLI is currently acting as.

groniz auth login

Starts an OAuth2 device-flow authentication. The CLI prints a short code and a verification URL, waits for you to approve the request in your browser, then saves a long-lived credential to disk.
1

Run the command

groniz auth login
2

Open the URL shown in your terminal

The CLI prints a verification URL and a one-time code. Open the URL in any browser and enter the code when prompted.
3

Approve the request

Sign in to your Groniz account and click Allow. The terminal polls automatically and confirms once the flow completes.
Credentials are written to ~/.groniz/credentials.json and are read automatically by every subsequent command. Example output
{
  "status": "authenticated",
  "id": "usr_abc123",
  "email": "you@example.com",
  "name": "Your Name"
}

groniz auth logout

Removes the stored credentials from ~/.groniz/credentials.json. After running this command, all CLI commands that require authentication will fail until you run groniz auth login again.
groniz auth logout
Example output
{
  "status": "logged_out"
}

groniz whoami

Returns the identity associated with the current credentials. Use this to verify that the correct account is active before running automated workflows.
groniz whoami
Example output
{
  "id": "usr_abc123",
  "email": "you@example.com",
  "name": "Your Name"
}

API key alternative

Instead of the OAuth2 device flow you can authenticate with a personal API key. Export it as an environment variable before running any command:
export GRONIZ_API_KEY=<your-api-key>
Get your API key from groniz.com/console/connectors/api-keys.
export only persists for the lifetime of the current shell session. In agent or CI environments the variable is lost when the process exits. Use groniz auth login and rely on the saved ~/.groniz/credentials.json file, or inject the key through your environment’s secret store so it is available on every invocation.
When both ~/.groniz/credentials.json and GRONIZ_API_KEY are present, the OAuth2 credentials from the login flow take priority.

Build docs developers (and LLMs) love