On this page
Kater CLI Your terminal auth
kater auth status
Checks that the Kater API of your target accepts your sign-in, and shows who you are.
It never shows a token. Use it after kater login, or when a command says that Kater rejected your sign-in.
Examples
# Check that you are signed in, and as whomkater auth status# Check your sign-in on the Kater API of the prod targetkater auth status --target prodOptions
It also takes the global options --json and --help.
What it shows
statusisauthenticatedwhen the API accepts your sign-in.user_idis your user id in Kater.api_urlis the API that it checked, andtargetis the target that names it.credential_sourceiskeychainfor the sign-in thatkater loginsaved, orprofilefor the target’stoken.
When your sign-in has expired, the command refreshes it first, and saves the new one.
When the check fails
The command exits with an error that says which of these it is:
- Rejected. The API did not accept your sign-in. Run
kater login, or replace the target’stokenwhen you use one. - Not reachable. The API did not answer. This is not the same as a rejected sign-in, and your saved sign-in does not change. Run
kater debugto check the setup. - Not signed in. You saved no sign-in for this API on this computer. Run
kater login.