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

The command opens your browser to approve the device. Compare its pairing code with your terminal before approving. Without --workspace, choose the workspace in the browser; one approval can authorize several workspaces with independent credentials. kylon login is an alias. Without --server-url, the CLI checks P2_API_URL, KYLON_WORKSPACE_API_URL, and KYLON_SERVER_URL in that order, then the default server recorded by the installer, and finally https://api.kylon.io.

​
Status

Shows the active user, workspace, and authentication state. kylon status and kylon auth status are the same command; the active workspace credential is selected automatically.

​
Logout

Clears stored CLI credentials. --workspace <id> logs out one workspace’s credential (add --server-url to limit it to one server), and --local-only clears local credentials without contacting Kylon. --json emits machine-readable output.

​
Change the computer’s account

Stops the Agents running on this installation, logs its computer connections out, and clears the connected account so you can sign in as someone else. This affects all workspaces served by that account on this installation. It cannot be combined with --local-only. To stop just one workspace’s local runtime connection while keeping other workspaces running, use kylon disconnect --workspace <workspace_id>. This is different from logging out a human workspace credential. See Gateway Commands.

​
Environment-based workspace auth

For non-interactive use, the workspace CLI can authenticate from environment variables:
Use an authorized credential for the intended caller and workspace. Agents started by Kylon receive their own runtime identity automatically; do not replace it with a human credential. For a remote machine without a browser, the single-use setup-token command from Settings → Developer tools → Kylon CLI is the supported sign-in path.