Skip to main content
Kane CLI authenticates against your account before it can run tests, upload sessions, or interact with Test Manager. There are two authentication methods:
  • OAuth: recommended for everyday local use. Opens a browser, you approve once, and tokens are stored on your machine.
  • Basic auth: your username and access key. Use this in CI and other non-interactive environments where no browser is available.

​
OAuth Login

Kane CLI opens the consent page in your default browser. Sign in and approve the request. When the browser hands control back, Kane CLI stores your tokens locally and you are signed in. You usually do not need to log in again on the same machine, because Kane CLI reuses the stored session on later runs. If you run kane-cli login in an interactive terminal without flags, Kane CLI starts a guided login wizard. It walks you through choosing a method and a profile and, for basic auth, entering your credentials.

​
Basic Auth

Basic auth uses your username and account access key. It is the right choice for CI runners, Docker containers, and any other environment where opening a browser is not possible.

​
Per-Run Flags

Pass credentials directly on the command you are running. They take precedence over any stored credentials:
Both kane-cli run and kane-cli feedback accept --username and --access-key.

​
Persistent Basic Auth

To save basic auth credentials for a profile so you do not have to pass them every time, log in with the basic auth flags:
Every later command you run under that profile uses the saved credentials automatically.

​
Where to Find Your Access Key

Sign in to the dashboard > Credentials and copy your access key. Treat it like a password: anyone with your username and access key can run tests on your account.

​
Profiles

A profile is a named login. Profiles are useful when you work with more than one account or organisation, or when you want separate credentials for personal and team use without re-authenticating each time you switch.

​
Create a Profile

Pass --profile <name> to login to authenticate under a named profile. If you omit --profile, Kane CLI uses the profile named default.
You can mix methods: one profile can use OAuth and another can use basic auth.

​
List Profiles

Prints each saved profile with its environment, marking the active one.

​
Switch the Active Profile

Every later command runs under work until you switch again.

​
Delete a Profile

Removes the stored credentials for that profile.

​
Run Against a Specific Profile Without Switching

Three commands accept --profile <name>, so you can use a profile for a single command without changing the active one: kane-cli login, kane-cli whoami, and kane-cli balance. For any other command, run kane-cli profiles switch first.

​
Check Who You Are Logged In As

whoami prints an identity card with the active profile, environment, authentication method (OAuth or basic), and username (when known). For OAuth, it also shows whether the stored token is valid, expired, or missing, and when it expires. Pass --profile <name> to inspect a profile other than the active one.

​
Log Out

logout signs out of the active profile and removes its credentials from disk. For OAuth profiles, Kane CLI first revokes the stored tokens with . If you have other profiles, Kane CLI switches to one of them automatically. Otherwise, no profile is active.

​
Where Credentials Are Stored

Credentials live under your home directory:
The file is created with restricted permissions (mode 0600) so only your user account can read it. There is no need to inspect or edit this file by hand. Use kane-cli login, kane-cli logout, and the kane-cli profiles commands to manage it.