get-sso-creds
Version:
CLI tool to retrieve or set AWS SSO credentials.
345 lines • 10.3 kB
JSON
{
"version": "6.4.3",
"commands": {
"assume": {
"id": "assume",
"description": "Assumes AWS Role.",
"strict": true,
"pluginName": "get-sso-creds",
"pluginAlias": "get-sso-creds",
"pluginType": "core",
"aliases": [],
"examples": [
"$ gscreds assume --role arn:aws:iam::996942091142:role/test-role",
"$ gscreds assume --role arn:aws:iam::996942091142:role/test-role -c --set-as 'my-profile'"
],
"flags": {
"help": {
"name": "help",
"type": "boolean",
"description": "Show CLI help.",
"allowNo": false
},
"json": {
"name": "json",
"type": "boolean",
"description": "Outputs credentials in json format.",
"allowNo": false
},
"credentials": {
"name": "credentials",
"type": "boolean",
"char": "c",
"description": "Writes credentials to ~/.aws/credentials (will use [default] as the profile name if --set-as flag is not used).",
"allowNo": false,
"exclusive": [
"clipboard"
]
},
"clipboard": {
"name": "clipboard",
"type": "boolean",
"char": "b",
"description": "Writes credentials to clipboard.",
"allowNo": false,
"exclusive": [
"credentials"
]
},
"set-as": {
"name": "set-as",
"type": "option",
"char": "n",
"description": "Desired name of profile when setting credentials via --credentials flag.",
"multiple": false,
"dependsOn": [
"credentials"
]
},
"role": {
"name": "role",
"type": "option",
"char": "r",
"description": "ARN of the role to assume.",
"required": true,
"multiple": false
},
"session-name": {
"name": "session-name",
"type": "option",
"char": "s",
"description": "Desired name for the role session.",
"multiple": false,
"dependsOn": [
"role"
],
"default": "gscreds-session"
},
"profile": {
"name": "profile",
"type": "option",
"char": "p",
"description": "Desired SSO config profile to use.",
"multiple": false,
"default": "default"
}
},
"args": {}
},
"clear": {
"id": "clear",
"description": "Clears selected credentials in ~/.aws/credentials.",
"strict": true,
"pluginName": "get-sso-creds",
"pluginAlias": "get-sso-creds",
"pluginType": "core",
"aliases": [],
"examples": [
"$ gscreds clear\n? Select a profile: (Use arrow keys)\n❯ default\n personal"
],
"flags": {
"help": {
"name": "help",
"type": "boolean",
"description": "Show CLI help.",
"allowNo": false
}
},
"args": {}
},
"console": {
"id": "console",
"description": "Opens AWS Console for a selected profile.",
"strict": true,
"pluginName": "get-sso-creds",
"pluginAlias": "get-sso-creds",
"pluginType": "core",
"aliases": [],
"examples": [
"$ gscreds console\n? Select a profile: (Use arrow keys)\n❯ default\n personal"
],
"flags": {
"help": {
"name": "help",
"type": "boolean",
"description": "Show CLI help.",
"allowNo": false
},
"browser": {
"name": "browser",
"type": "option",
"char": "b",
"description": "Opens designated browser over the system default.\n\n Suggested values: [\"chrome\", \"firefox\", \"edge\"]",
"multiple": false,
"options": [
"chrome",
"firefox",
"edge"
]
}
},
"args": {}
},
"get": {
"id": "get",
"description": "Get AWS SSO credentials from existing profiles in ~/.aws/config.",
"strict": true,
"pluginName": "get-sso-creds",
"pluginAlias": "get-sso-creds",
"pluginType": "core",
"aliases": [],
"examples": [
"$ gscreds get\n? Select a profile: (Use arrow keys)\n❯ default\n dev\n prod\n personal\n\nProfile: my-profile\nCredentials expire at: 6:20:24 PM\n\nexport AWS_ACCESS_KEY_ID=<AWS_ACCESS_KEY_ID>\nexport AWS_SECRET_ACCESS_KEY=<AWS_SECRET_ACCESS_KEY>\nexport AWS_SESSION_TOKEN=<AWS_SESSION_TOKEN>"
],
"flags": {
"help": {
"name": "help",
"type": "boolean",
"description": "Show CLI help.",
"allowNo": false
},
"credentials": {
"name": "credentials",
"type": "boolean",
"char": "c",
"description": "Writes credentials to ~/.aws/credentials (will use default as the profile name if --preserve flag is not used).",
"allowNo": false,
"exclusive": [
"clipboard"
]
},
"clipboard": {
"name": "clipboard",
"type": "boolean",
"char": "b",
"description": "Writes credentials to clipboard.",
"allowNo": false,
"exclusive": [
"credentials"
]
},
"preserve": {
"name": "preserve",
"type": "boolean",
"char": "P",
"description": "Sets selected profile name as the profile name in ~/.aws/credentials when using --credentials flag.",
"allowNo": false,
"dependsOn": [
"credentials"
]
},
"json": {
"name": "json",
"type": "boolean",
"description": "Outputs credentials in json format.",
"allowNo": false
}
},
"args": {}
},
"login": {
"id": "login",
"description": "Initiates AWS SSO login.",
"strict": true,
"pluginName": "get-sso-creds",
"pluginAlias": "get-sso-creds",
"pluginType": "core",
"aliases": [],
"examples": [
"$ gscreds login --profile your-profile\nLogging in... ⣽"
],
"flags": {
"help": {
"name": "help",
"type": "boolean",
"description": "Show CLI help.",
"allowNo": false
},
"profile": {
"name": "profile",
"type": "option",
"char": "p",
"description": "Profile name to use for login.",
"multiple": false,
"default": "default"
}
},
"args": {}
},
"logout": {
"id": "logout",
"description": "Initiates AWS SSO logout.",
"strict": true,
"pluginName": "get-sso-creds",
"pluginAlias": "get-sso-creds",
"pluginType": "core",
"aliases": [],
"examples": [
"$ gscreds logout --profile your-profile\nLogging out... ⣽"
],
"flags": {
"help": {
"name": "help",
"type": "boolean",
"description": "Show CLI help.",
"allowNo": false
},
"profile": {
"name": "profile",
"type": "option",
"char": "p",
"description": "Profile name to use for logout.",
"multiple": false,
"default": "default"
}
},
"args": {}
},
"ls": {
"id": "ls",
"description": "Lists profile names in ~/.aws/config or ~/.aws/credentials.",
"strict": true,
"pluginName": "get-sso-creds",
"pluginAlias": "get-sso-creds",
"pluginType": "core",
"aliases": [],
"examples": [
"$ gscreds ls\n? Select a file: (Use arrow keys)\n❯ config\n credentials"
],
"flags": {
"help": {
"name": "help",
"type": "boolean",
"description": "Show CLI help.",
"allowNo": false
}
},
"args": {}
},
"select": {
"id": "select",
"description": "Get AWS SSO credentials via AWS SSO.",
"strict": true,
"pluginName": "get-sso-creds",
"pluginAlias": "get-sso-creds",
"pluginType": "core",
"aliases": [],
"examples": [
"$ gscreds select\n? Select an SSO url: (Use arrow keys)\n❯ https://alpha.awsapps.com/start\n https://delta.awsapps.com/start\n? Select an SSO account:\n❯ Log archive | ctlogs@google.com | 111111111111\n test-alpha | testalpha@yahoo.com | 222222222222\n? Select an SSO role: (Use arrow keys)\n❯ AWSServiceCatalogEndUserAccess\n AWSAdministratorAccess\n ..."
],
"flags": {
"help": {
"name": "help",
"type": "boolean",
"description": "Show CLI help.",
"allowNo": false
},
"credentials": {
"name": "credentials",
"type": "boolean",
"char": "c",
"description": "Writes credentials to ~/.aws/credentials (will use [default] as the profile name if --set-as flag is not used).",
"allowNo": false,
"exclusive": [
"clipboard"
]
},
"clipboard": {
"name": "clipboard",
"type": "boolean",
"char": "b",
"description": "Writes credentials to clipboard.",
"allowNo": false,
"exclusive": [
"credentials"
]
},
"json": {
"name": "json",
"type": "boolean",
"description": "Outputs credentials in json format.",
"allowNo": false
},
"set-as": {
"name": "set-as",
"type": "option",
"char": "n",
"description": "Desired name of profile when setting credentials via --credentials flag.",
"multiple": false,
"dependsOn": [
"credentials"
]
},
"profile": {
"name": "profile",
"type": "option",
"char": "p",
"description": "Desired SSO config profile to use.",
"multiple": false,
"default": "default"
}
},
"args": {}
}
}
}