Skip to main content
The auth command helps you manage authentication and account profiles for the Xata CLI.

​
Subcommands

​
login

Log in to a Xata account. 
xata auth login [--env prod|custom] [--profile <name>] [-f|--force] [-h|--help]
​
--env
string
Environment to log in to (prod|custom, default: prod)
​
--profile
string
Profile to log in to (default: default)
​
-f, --force
boolean
Force login even if already logged in
​
-h, --help
boolean
Print help information and exit

​
Custom environment flags

For Enterprise customers we allow connecting the CLI to a custom deployment in their cloud. They can configure it with the custom environment. When using --env custom, you can provide additional configuration:
​
--custom-issuer
string
Issuer URL for custom environment (required for custom environments)
​
--custom-api-base-url
string
API base URL for custom environment (required for custom environments)
​
--custom-client-secret
string
Client secret for custom environment (required for custom environments)
​
--custom-client-id
string
Client ID for custom environment (defaults to cli)
If these flags are not provided, the CLI will prompt you for the required values interactively.

​
logout

Log out of the current account. 
xata auth logout [--profile <name>] [--yes] [-h|--help]
​
--profile
string
Profile to log out of (default: default)
​
--yes
boolean
Do not ask for confirmation, assume yes
​
-h, --help
boolean
Print help information and exit

​
status

Display active account and authentication state. 
xata auth status [--profile <name>] [-h|--help]
​
--profile
string
Profile to log in to (default: default)
​
-h, --help
boolean
Print help information and exit

​
switch

Switch to a different Xata account profile. 
xata auth switch <profile>
xata auth switch --help
​
profile
string
required
The profile to switch to
​
-h, --help
boolean
Print help information and exit

​
access-token

Print the current access token. 
xata auth access-token [--profile <name>] [-h|--help]
​
--profile
string
Profile to log in to (default: default)
​
-h, --help
boolean
Print help information and exit

​
refresh-token

Print the current refresh token. 
xata auth refresh-token [--profile <name>] [-h|--help]
​
--profile
string
Profile to log in to (default: default)
​
-h, --help
boolean
Print help information and exit

​
Global Flags

​
-h, --help
boolean
Print help information and exit