Skip to content
This repository has been archived by the owner on Jan 12, 2023. It is now read-only.

Latest commit

 

History

History
148 lines (112 loc) · 4.15 KB

README.md

File metadata and controls

148 lines (112 loc) · 4.15 KB
Raw

AWS ASAP - The AWS Secrets and Parameters Searching Tool

oclif Version Downloads/week License

Requirements

You will need to have an active AWS session in your current shell against the target account in order to retrieve Secrets and Parameters.

The following permissions are required for each of the resources you're attempting to retrieve:

  • ps

    • ssm:DescribeParameters
    • ssm:GetParameters
    • kms:Decrypt (if using SecureString type with own CMK rather than AWS-managed)

  • sm

    • secretsmanager:ListSecrets
    • secretsmanager:GetSecretValue
    • kms:Decrypt (if using own CMK rather than AWS-managed)

Usage

$ npm install -g aws-asap
$ asap COMMAND
running command...
$ asap (-v|--version|version)
aws-asap/0.2.4 darwin-x64 node-v12.18.2
$ asap --help [COMMAND]
USAGE
  $ asap COMMAND
...

Commands

asap autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ asap autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

OPTIONS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

EXAMPLES
  $ asap autocomplete
  $ asap autocomplete bash
  $ asap autocomplete zsh
  $ asap autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

asap help [COMMAND]

display help for asap

USAGE
  $ asap help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

asap ps

search parameters in AWS SSM Parameter Store

USAGE
  $ asap ps

OPTIONS
  -d, --disable-decryption       disable decryption of SecureString type params by default
  -h, --help                     show CLI help
  -n, --max-results=max-results  limit for amount of results returned, default is 50
  -r, --region=region            AWS region override
  -t, --term=term                term to search
  -x, --extended                 show extra columns
  --all                          retrieve every parameter in the region
  --csv                          output is csv format
  --no-header                    hide table header from output
  --no-limit                     retrieve every parameter for the search term
  --no-truncate                  do not truncate output to fit screen

EXAMPLE
  $ asap ps -t awesome-param

See code: src/commands/ps.ts

asap sm

search parameters in AWS Secrets Manager

USAGE
  $ asap sm

OPTIONS
  -h, --help                     show CLI help
  -n, --max-results=max-results  limit for amount of results returned, default is 50
  -r, --region=region            AWS region override
  -t, --term=term                term to search
  -x, --extended                 show extra columns
  --all                          retrieve every parameter in the region
  --csv                          output is csv format
  --no-header                    hide table header from output
  --no-limit                     retrieve every parameter for the search term
  --no-truncate                  do not truncate output to fit screen

EXAMPLE
  $ asap sm -t awesome-param
  awesome param value

See code: src/commands/sm.ts