Configuration file

Polaris reads ~/.config/polaris/config.toml on start. CLI flags override file values. Env vars override both.

[auth]
method = "oauth"          # "oauth" | "token" | "iam"
cache_credentials = true

[server]
endpoint = "https://api.polaris.example.com"
timeout_seconds = 30

[output]
format = "table"          # "table" | "json" | "csv"
colour = "auto"           # "auto" | "always" | "never"

Environment variables

Variable Default Purpose
POLARIS_TOKEN Override the cached OAuth token
POLARIS_ENDPOINT https://api.polaris.example.com Override the API endpoint
POLARIS_TIMEOUT 30 Per-request timeout in seconds
POLARIS_FORMAT table Default output format
POLARIS_NO_COLOUR unset Disable ANSI colour in output

CLI flags

Flags accepted by every command: