Skip to content

kai-nguyen-aligent/store-parameters

Repository files navigation

store-parameters

CLI tool for import and export SSM parameters

oclif Version Downloads/week Buy Me a Coffee

Features

  • 🔄 Import & Export - Seamlessly import and export AWS SSM parameters to/from CSV files
  • 👤 AWS Profile Support - Select from multiple AWS profiles with interactive prompts and MFA support
  • 🔐 1Password Integration - Reference secrets directly from 1Password vaults using op:// URI format
  • 🔒 Secure Strings - Full support for both String and SecureString parameter types
  • 📊 Custom Delimiters - Support for CSV, TSV, and custom delimiter formats
  • ✅ CSV Validation - Built-in validation to ensure data integrity before import

Usage

$ npm install -g store-parameters
$ store-parameters COMMAND
running command...
$ store-parameters (--version)
store-parameters/1.1.2 linux-x64 node-v20.19.5
$ store-parameters --help [COMMAND]
USAGE
  $ store-parameters COMMAND
...

Commands

store-parameters export FILE

Export SSM path to csv file

USAGE
  $ store-parameters export FILE -p <value> [--json] [--profile <value>] [--region <value>] [-d <value>]

ARGUMENTS
  FILE  Output csv file

FLAGS
  -d, --delimiter=<value>  Custom delimiter of csv file
  -p, --path=<value>       (required) SSM path to export
      --profile=<value>    AWS profile name in ~/.aws/credentials
      --region=<value>     [default: ap-southeast-2] AWS region

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Export SSM path to csv file

EXAMPLES
  $ store-parameters export <path-to-csv-file> --path </ssm/path>

See code: src/commands/export.ts

store-parameters help [COMMAND]

Display help for store-parameters.

USAGE
  $ store-parameters 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 store-parameters.

See code: @oclif/plugin-help

store-parameters import FILE

Import csv file to SSM

USAGE
  $ store-parameters import FILE [--json] [--profile <value>] [--region <value>] [-d <value>]

ARGUMENTS
  FILE  Input csv file

FLAGS
  -d, --delimiter=<value>  Custom delimiter of csv file
      --profile=<value>    AWS profile name in ~/.aws/credentials
      --region=<value>     [default: ap-southeast-2] AWS region

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Import csv file to SSM

EXAMPLES
  $ store-parameters import <path-to-csv-file>

See code: src/commands/import.ts

About

CLI tool for import and export SSM parameters

Resources

Stars

Watchers

Forks

Packages

No packages published