awsum

aws cli utility for sso

This tool allows you to populate your ~/.aws/config with all the sso roles that you have access to - and makes it easy to switch between profiles. It uses oclif as the cli framework to make things easy to develop and extend.

Purpose and goals:

• provide simple, opinionated ways to do common things with the aws cli
• provide simple, opinionated ways to do common things with aws using the local shell
• easy to install and update
• easy to extend

This tool has been initially developed on macos, ymmv on elsewhere. I'd be happy to accept contributions that enable or improve functionality on other systems.

• awsum

Dependencies

• AWS CLI
• Node runtime

Installation

install node, then install this package via npm install -g @davidpricedev/awsum

Usage

$ npm install -g @davidpricedev/awsum
$ awsum COMMAND
running command...
$ awsum (--version)
@davidpricedev/awsum/0.1.0 darwin-arm64 node-v22.9.0
$ awsum --help [COMMAND]
USAGE
  $ awsum COMMAND
...

Commands

• awsum
  • Dependencies
  • Installation
  • Usage
  • Commands
  • awsum help [COMMAND]
  • awsum sso info
  • awsum sso install-switcher SHELL
  • awsum sso login
  • awsum sso profile
  • awsum sso setup
  • Contributing
  • Publishing
  • Future

awsum help [COMMAND]

Display help for awsum.

USAGE
  $ awsum help [COMMAND...] [-n]

ARGUMENTS
  COMMAND...  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for awsum.

See code: @oclif/plugin-help

awsum sso info

Show current AWS context information

USAGE
  $ awsum sso info

DESCRIPTION
  Show current AWS context information

EXAMPLES
  $ awsum sso info

See code: src/commands/sso/info.ts

awsum sso install-switcher SHELL

Install a profile switcher function into your .zshr/.basrc file

USAGE
  $ awsum sso install-switcher SHELL

ARGUMENTS
  SHELL  shell (bash or zsh)

DESCRIPTION
  Install a profile switcher function into your .zshr/.basrc file

EXAMPLES
  $ awsum sso install-switcher

See code: src/commands/sso/install-switcher.ts

awsum sso login

Login to AWS SSO

USAGE
  $ awsum sso login [-p <value>]

FLAGS
  -p, --profile=<value>  AWS profile to use

DESCRIPTION
  Login to AWS SSO

EXAMPLES
  $ awsum sso login

See code: src/commands/sso/login.ts

awsum sso profile

choose an aws profile

USAGE
  $ awsum sso profile [-q]

FLAGS
  -q, --quiet  suppress text output

DESCRIPTION
  choose an aws profile

EXAMPLES
  $ awsum sso profile

See code: src/commands/sso/profile.ts

awsum sso setup

Sets up SSO for the first time

USAGE
  $ awsum sso setup [-r <value>] [-s <value>]

FLAGS
  -r, --ssoRegion=<value>  sso region
  -s, --startUrl=<value>   sso start url

DESCRIPTION
  Sets up SSO for the first time

EXAMPLES
  $ awsum sso setup

See code: src/commands/sso/setup.ts

Contributing

• Clone the repo
• Run npm install to install dependencies
• Run npm run install-precommit - to install the pre-commit hooks that keep things nicely formatted
  • First install pre-commit, if you haven't yet, via brew install pre-commit
• Run npm install -g oclif to install the oclif command line tools
• Abide by the code of conduct
• Development Workflow
  • npm run build to build the project
  • bin/run.js ... to run the cli tooling without installing it
  • add tests to the test folder corresponding to the command

Publishing

Future

• switch to the built-in dataDir in oclif instead of custom file locations (this.config.dataDir and this.config.configDir within a command)
• add common functionality for common things beyond sso: code artifact logins, ecr login, lambda invokes, ssm connections, etc.