get-sso-creds

CLI tool to get AWS SSO temporary credentials.

• Prerequisites
• Usage

Prerequisites

In order for get-sso-creds to work properly AWS CLI v2 must be installed beforehand.

AWS CLI v2

https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html

Install

npm install -g get-sso-creds

Examples

AWS CLI will use the default profile if no profile is given. Out of convenience the -c flag from the select command will set the default profile in ~/.aws/credentials for you. Thus subsequent awscli commands will no longer require you to use --profile if you plan on using a specific set of credentials for a period of time. ie. rather than typeing aws s3 ls --profile="my-profile" you can just type aws s3 ls after allowing gsc to set the credentials for you.

gsc select -c

Conversely if you prefer to store named credentials you can use the --set-as=name flag with select. This will allow you to set credentials as the specified profile name.

gsc select -c --set-as="dev-profile"

aws s3 ls --profile="dev-profile"

Commands

CLI tool to retrieve or set AWS SSO credentials

USAGE
  $ gsc [COMMAND]

TOPICS
  plugins  List installed plugins.

COMMANDS
  clear    Clears selected credentials in ~/.aws/credentials
  get      Get AWS SSO credentials via existing profile in ~/.aws/config
  help     Display help for gsc.
  login    Initiates AWS SSO login
  logout   Initiates AWS SSO logout
  ls       Lists profile names in ~/.aws/config or ~/.aws/credentials
  plugins  List installed plugins.
  select   Get AWS SSO credentials via AWS SSO

get command

Get AWS SSO credentials via existing profile in ~/.aws/config

USAGE
  $ gsc get [--help] [-P -c] [--json]

FLAGS
  -P, --preserve     Sets selected profile name as the profile name in ~/.aws/credentials when using --credentials flag
  -c, --credentials  Writes credentials to ~/.aws/credentials (will use default as the profile name if --preserve flag is not used)
  --help             Show CLI help.
  --json             Outputs credentials in json format

DESCRIPTION
  Get AWS SSO credentials via existing profile in ~/.aws/config

EXAMPLES
  $ gsc get
  ? Select a profile: (Use arrow keys)
  ❯ default
    dev
    prod
    personal
  Profile: my-profile
  Credentials expire at: 6:20:24 PM
  export AWS_ACCESS_KEY_ID=<AWS_ACCESS_KEY_ID>
  export AWS_SECRET_ACCESS_KEY=<AWS_SECRET_ACCESS_KEY>
  export AWS_SESSION_TOKEN=<AWS_SESSION_TOKEN>

select command

Get AWS SSO credentials via AWS SSO.

USAGE
  $ gsc select [--help] [--json] [-n <value> -c] [-p <value>]

FLAGS
  -c, --credentials      writes credentials to ~/.aws/credentials (will use default as the profile name if --set-profile-as flag is not
                         used).
  -n, --set-as=name      Desired name of profile when setting credentials via --credentials flag.
  -p, --profile=default  (Optional) Desired SSO config profile to use. If not specified, will use default profile.
  --help                 Show CLI help.
  --json                 Outputs credentials in json format.

DESCRIPTION
  Get AWS SSO credentials via AWS SSO.

EXAMPLES
  $ gsc select
  ? Select an SSO url: (Use arrow keys)
  ❯ https://alpha.awsapps.com/start
    https://delta.awsapps.com/start
  ? Select an SSO account:
  ❯ Log archive | ctlogs@google.com | 111111111111
    test-alpha | testalpha@yahoo.com | 222222222222
  ? Select an SSO role: (Use arrow keys)
  ❯ AWSServiceCatalogEndUserAccess
    AWSAdministratorAccess
   ...

ls command

Lists profile names in ~/.aws/config or ~/.aws/credentials

USAGE
  $ gsc ls [--help]

FLAGS
  --help  Show CLI help.

DESCRIPTION
  Lists profile names in ~/.aws/config or ~/.aws/credentials

EXAMPLES
  $ gsc ls
  ? Select a file: (Use arrow keys)
  ❯ config
    credentials

login command

Initiates AWS SSO login

USAGE
  $ gsc login [--help] [-p <value>]

FLAGS
  -p, --profile=<value>  [default: default] Profile name to use for login
  --help                 Show CLI help.

DESCRIPTION
  Initiates AWS SSO login

EXAMPLES
  $ gsc login --profile your-profile
  Logging in... ⣽

logout command

Initiates AWS SSO logout

USAGE
  $ gsc logout [--help] [-p <value>]

FLAGS
  -p, --profile=<value>  [default: default] Profile name to use for logout
  --help                 Show CLI help.

DESCRIPTION
  Initiates AWS SSO logout

EXAMPLES
  $ gsc logout --profile your-profile
  Logging out... ⣽

clear command

Clears selected credentials in ~/.aws/credentials

USAGE
  $ gsc clear [--help]

FLAGS
  --help  Show CLI help.

DESCRIPTION
  Clears selected credentials in ~/.aws/credentials

EXAMPLES
  $ gsc clear
  ? Select a profile: (Use arrow keys)
  ❯ default
    personal