Last modified March 2, 2022
'gsctl login' command reference
gsctl and the REST API are being phased out. We don't have an end-of-life date yet. However, we recommend to familiarize yourself with our Management API and the kubectl gs plugin as a future-proof replacement. We provide a migration page to help you with the transition.
With gsctl login
you can authenticate against an API endpoint. Your session will
stay authenticated until you use gsctl logout
.
Usage
The standard form of executing a login against an endpoint:
gsctl login <email> [-e|--endpoint <endpoint>]
Example:
$ gsctl login user@email.com -e https://api.g8s.example.eu-central-1.aws.gigantic.io
Password for user@email.com on https://api.g8s.example.eu-central-1.aws.gigantic.io:
The password will not be displayed during input.
The -e
/--endpoint
flag is optional. If you have been logged in with the same
endpoint before and it is still the selected one, which you can check using
gsctl info
, you can omit the endpoint part.
Non-interactive login
For usage in a script or any other type of information, the password can be
provided as a command line argument using the -p
or --password
option. The
syntax is as follows:
gsctl login <email> -e <endpoint> -p <password>
Related
Need help, got feedback?
We listen to your Slack support channel. You can also reach us at support@giantswarm.io. And of course, we welcome your pull requests!