bwhaley/ssmsh
bwhaley/ssmsh has 296 GitHub stars and 15 forks. GitHot measured 0 stars in 24 hours and 0 in 7 days. Last checked 2026-11-22 00:34 UTC. Last push 2026-10-29.
Crecimiento de estrellas medido
- in 24h
- 0
- in 7 days
- 0
- in 15 days
- Recopilando historial
- in 1 month
- Recopilando historial
Cambios netos en períodos que se solapan, no totales diarios. Los datos no disponibles se dejan en blanco. Las estrellas indican interés, no calidad.
Acerca de
A shell for the EC2 Parameter Store
Herramientas de desarrolloREADME.md
Originalssmsh
ssmsh is an interactive shell and command-line client for AWS Systems Manager Parameter Store. It provides familiar commands such as cd, ls, get, put, cp, mv, and rm, including relative paths, recursion, multiple regions, parameter history, advanced parameter policies, and batch execution.
The interactive prompt shows the active AWS profile, region, and Parameter Store path:
[production@us-west-2] /service/api> ls
database/
endpoint
Installation
Download macOS, Linux, or Windows archives from GitHub Releases, or install the current source with Go 1.27.2:
go install github.com/bwhaley/ssmsh@latest
The repository also acts as a Homebrew tap for macOS and Linux:
brew tap bwhaley/ssmsh https://github.com/bwhaley/ssmsh
brew install ssmsh
A community-maintained Nix package is also available.
Upgrading from v1
Version 2 updates the CLI behavior as well as its dependencies. Before upgrading automation or shared environments, account for these changes:
- Source builds require Go 1.27.2.
getandhistoryuse stable tab-separated text output. Use-output valuefor values alone or-output jsonfor structured records.- Command failures now produce a nonzero exit status, batch files stop at the first failure, and
getfails if any requested name is missing. - Configuration files accept only the documented keys in
[default]; an explicitly selected missing file is an error. - An unset profile uses the complete AWS SDK credential chain instead of selecting the
defaultprofile explicitly. - Copying preserves tags and therefore needs
ssm:ListTagsForResourceandssm:AddTagsToResource. Cross-region SecureString copies need a destination KMS key. - Consumers of the Go packages must migrate to context-aware APIs and AWS SDK for Go v2 types.
See the v2.0.0 changelog for the complete release notes.
AWS configuration
ssmsh uses the AWS SDK for Go v2 credential chain. Environment credentials, shared profiles, IAM roles, web identity credentials, workload credentials, and IAM Identity Center (SSO) profiles are supported. Configure credentials using the AWS SDK and Tools reference guide.
An optional ~/.ssmshrc sets command defaults:
[default]
type=SecureString
overwrite=false
decrypt=false
profile=my-profile
region=us-east-1
key=alias/parameter-store
output=text
Use -config path to select another file. A missing explicitly selected file is an error; a missing default ~/.ssmshrc is allowed.
AWS_PROFILE takes precedence over the configured profile. AWS_REGION takes precedence over the configured region. When neither is set, the AWS SDK resolves its usual environment, shared-config, and workload defaults. An empty profile leaves the complete SDK credential chain available.
Supported output modes are text, json, and value. Set one in the configuration file or with -output. JSON uses records owned by ssmsh, so SDK upgrades do not silently change the output field set.
Usage
Run ssmsh for the interactive shell, pass a command directly, or read commands from a file:
ssmsh
ssmsh get /service/api/endpoint
ssmsh -output value get /service/api/password
ssmsh -file commands.txt
cat commands.txt | ssmsh -file -
Every command has a two-minute timeout by default. Change it with a Go duration such as -timeout 30s. Ctrl-C cancels an in-flight command.
Use help or help COMMAND to inspect available commands:
cd change parameter directory
cp copy parameters
decrypt set parameter decryption
exit exit the interactive shell
get get parameters
history get parameter history
key set the destination KMS key
ls list parameters
mv move parameters
policy create a named parameter policy
profile switch AWS profile
put set a parameter
region switch AWS region
rm remove parameters
Paths and regions
Paths may be absolute or relative to the current Parameter Store directory. Prefix a path with a region to target another region:
cd /service
ls api
get api/endpoint
get us-east-1:/service/api/endpoint us-west-2:/service/api/endpoint
ls -r eu-central-1:/service
Use profile NAME and region NAME to switch the active AWS configuration. The new configuration is validated before the current client cache is replaced.
Reading values and history
ssmsh get /service/api/endpoint
ssmsh -output json history /service/api/endpoint
ssmsh -output value get /service/api/password
SecureString values are encrypted in responses unless decryption is enabled:
decrypt true
decrypt false
Creating parameters
Supply a value directly, read it byte-for-byte from a file, or read it from standard input:
ssmsh put name=/service/api/endpoint value=https://example.com type=String
ssmsh put name=/service/api/private-key value-file=private.pem type=SecureString
printf '%s' "$SECRET" | ssmsh put name=/service/api/password value-stdin=true type=SecureString
value-file and value-stdin preserve whitespace and newlines. value-stdin cannot be combined with -file -, because both would consume the same stream. Inline values may be visible in shell history or process listings; prefer a file or standard input for secrets.
Interactive put with no arguments reads one name=value option per line until an empty line. Interactive command history remains in memory and is not written to disk.
Press Tab to complete command names and parameter paths; press Tab again to explore
ambiguous matches. For example, ls /nonprod/pas completes matching names or
subdirectories. Completion supports relative paths, region: prefixes, and
put name=...; cd suggests directories only. Quoted tokens and completion in the
middle of a word are left unchanged.
Path completion requires ssm:DescribeParameters. It requests metadata only and
never reads or decrypts parameter values. Results are cached in memory for 30
seconds, scoped to the profile, region, and resolved prefix. Writes and profile or
region commands clear the cache, including failed commands that may have partially
changed remote state. Lookups stop after two seconds or ten pages of up to 50
parameters; incomplete results are discarded, with a message to narrow the prefix
when the page limit is reached. Permission and network errors leave normal command
execution available. Completion runs on Tab, not on every keystroke.
Advanced parameter policies can be named and reused during a session:
policy expiry Expiration(Timestamp=2030-01-01T00:00:00Z)
policy notices ExpirationNotification(Before=30,Unit=days) NoChangeNotification(After=7,Unit=days)
put name=/service/api/token value-file=token type=SecureString policies=[expiry,notices]
Copying, moving, and removing
cp /service/api/endpoint /backup/endpoint
cp -r /service /backup
mv /service/old-name /service/new-name
rm /service/api/endpoint
rm -r /service/obsolete
Copy preserves the current value, description, allowed pattern, data type, tier, policies, and tags. A cross-region SecureString copy requires a destination KMS key:
cp key=alias/destination -r us-east-1:/service us-west-2:/service
You can also set the active destination key with key KEY_ID_OR_ALIAS.
mv copies every destination before deleting any source. If copying fails, sources remain. If source cleanup fails after a successful copy, the error identifies that the destinations exist and cleanup is incomplete.
Preview mutations with the global option or a command option:
ssmsh -dry-run rm -r /service/obsolete
ssmsh cp --dry-run -r /service /backup
ssmsh mv --dry-run /service/old /service/new
Dry-run output contains names and regions, never parameter values.
Batch behavior
Batch files support blank lines, comments beginning with #, and shell-style quoting. Execution stops at the first invalid command or AWS error and returns a nonzero exit status. Error messages identify the line number without echoing the command, which could contain a secret.
# commands.txt
put name=/service/api/endpoint value="https://example.com" type=String
cp /service/api/endpoint /backup/api/endpoint
rm /service/api/old-endpoint
Development
The project requires Go 1.27.2. Common checks are exposed through the Makefile:
make check # format, vet, and race-enabled tests
make lint # static analysis
make vuln # reachable vulnerability analysis
make build # bin/ssmsh
make snapshot # local GoReleaser snapshot
CI runs tests on Linux, macOS, and Windows, checks the module files, runs vulnerability analysis, and builds a release snapshot. Tagged releases use the pinned GoReleaser version and refresh the source-based Homebrew formula.
License
MIT
Explorar proyectos relacionados
Cargando…