0.0.4 • Published 3 years ago

@mudita/sm-cli v0.0.4

Weekly downloads
7
License
MIT
Repository
github
Last release
3 years ago

SM-CLI

Secrets manager for sharing environment variables

oclif Version CircleCI Codecov Downloads/week License

Usage

$ npm install -g @mudita/sm-cli
$ sm-cli COMMAND
running command...
$ sm-cli (-v|--version|version)
@mudita/sm-cli/0.0.3 darwin-x64 node-v13.8.0
$ sm-cli --help [COMMAND]
USAGE
  $ sm-cli COMMAND
...

Commands

sm-cli add

This command used to adding new variable to .env file

USAGE
  $ sm-cli add

OPTIONS
  -h, --help         show CLI help
  -k, --key=key      variable key
  -v, --value=value  variable value

EXAMPLES
  $ sm-cli add
  $ sm-cli add -k VARIABLE_KEY -v VARIABLE_VALUE

See code: src/commands/add.ts

sm-cli display

This command used to displaying variables list from .env file

USAGE
  $ sm-cli display

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ sm-cli display

See code: src/commands/display.ts

sm-cli fetch

This command used to fetch the secrets manager data and save it into .env file

USAGE
  $ sm-cli fetch

OPTIONS
  -h, --help             show CLI help
  -p, --profile=profile  AWS profile name

EXAMPLES
  $ sm-cli fetch
  $ sm-cli fetch -p PROFILE_NAME

See code: src/commands/fetch.ts

sm-cli help [COMMAND]

display help for sm-cli

USAGE
  $ sm-cli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

sm-cli init

This command used to init the secrets manager in root directory of the project

USAGE
  $ sm-cli init

OPTIONS
  -h, --help             show CLI help
  -p, --project=project  Project secrets name
  -r, --region=region    Secrets manager region

EXAMPLES
  $ sm-cli init
  $ sm-cli init -p PROJECT_NAME -r SECRETS_MANAGER_REGION

See code: src/commands/init.ts

sm-cli remove

This command used to removing new variable from .env file

USAGE
  $ sm-cli remove

OPTIONS
  -h, --help     show CLI help
  -k, --key=key  variable key

EXAMPLES
  $ sm-cli remove
  $ sm-cli remove -k VARIABLE_KEY

See code: src/commands/remove.ts

sm-cli sync

This command used to sync variable from local environment with AWS SecretsManager

USAGE
  $ sm-cli sync

OPTIONS
  -h, --help             show CLI help
  -p, --profile=profile  AWS profile name

EXAMPLES
  $ sm-cli fetch
  $ sm-cli fetch -p PROFILE_NAME

See code: src/commands/sync.ts

sm-cli update

This command used to update existing variable in .env file

USAGE
  $ sm-cli update

OPTIONS
  -h, --help         show CLI help
  -k, --key=key      variable key
  -v, --value=value  variable value

EXAMPLES
  $ sm-cli update
  $ sm-cli update -k VARIABLE_KEY -v VARIABLE_VALUE

See code: src/commands/update.ts