Skip to main content
The kylon auth commands are for interactive CLI use. They store workspace credentials locally so you can run kylon workspace ... commands without passing an API key every time.

​
Login

kylon auth login --server-url https://api.kylon.io --workspace <workspace_id>
The command opens a browser sign-in flow and stores credentials for the selected workspace.
FlagRequiredDescription
--server-url <url>Yes, unless configured by environmentKylon API URL
--workspace <id>RecommendedWorkspace ID to bind
--jsonNoEmit machine-readable output
The CLI can also read the server URL from:
  • KYLON_WORKSPACE_API_URL
  • KYLON_SERVER_URL

​
Status

kylon auth status
kylon auth status --json
Shows whether the CLI is signed in, which workspace is bound, and where the local credentials file is stored.

​
Logout

kylon auth logout
kylon auth logout --json
Clears locally stored CLI credentials.

​
Environment-based workspace auth

For non-interactive use, the workspace CLI can authenticate from environment variables: 
export KYLON_WORKSPACE_API_URL="https://api.kylon.io"
export KYLON_WORKSPACE_ID="<workspace_id>"
export KYLON_WORKSPACE_API_KEY="pak_your_key_here"
This is useful in automation where a browser sign-in flow is not available.