auth command helps you manage authentication and account profiles for the Xata CLI.
Subcommands
login
Log in to a Xata account.string
Profile to log in to (default:
default)boolean
Force login even if already logged in
boolean
Print help information and exit
Custom environment flags
For Enterprise customers we allow connecting the CLI to a custom deployment in their cloud. Pass any of the flags below to log in against a non-production environment; if omitted, the CLI uses the default production values.string
Issuer URL for the custom environment
string
API base URL for the custom environment
string
Client ID for the custom environment (defaults to
cli)string
Client secret for the custom environment
list
List all available Xata account profiles.boolean
Output the list of profiles in JSON format
boolean
Print help information and exit
logout
Log out of the current account.string
Profile to log out of (default:
default)boolean
Do not ask for confirmation, assume yes
boolean
Print help information and exit
status
Display active account and authentication state.string
Profile to log in to (default:
default)boolean
Print help information and exit
switch
Switch to a different Xata account profile.string
required
The profile to switch to
boolean
Print help information and exit
access-token
Print the current access token.string
Profile to log in to (default:
default)boolean
Print help information and exit
refresh-token
Print the current refresh token.string
Profile to log in to (default:
default)boolean
Print help information and exit
Global Flags
boolean
Print help information and exit