https://github.com/clok/sm
AWS Secrets Manager CLI Tool
https://github.com/clok/sm
aws aws-secrets-manager cli go golang
Last synced: over 1 year ago
JSON representation
AWS Secrets Manager CLI Tool
- Host: GitHub
- URL: https://github.com/clok/sm
- Owner: clok
- License: mit
- Created: 2021-06-17T18:04:11.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-03-05T14:29:41.000Z (over 1 year ago)
- Last Synced: 2025-03-18T04:35:25.065Z (over 1 year ago)
- Topics: aws, aws-secrets-manager, cli, go, golang
- Language: Go
- Homepage: https://clok.sh/sm/
- Size: 52.7 KB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# sm - AWS Secrets Manager CLI Tool
[](https://github.com/clok/sm/blob/master/LICENSE)
[](https://goreportcard.com/report/clok/sm)
[](https://coveralls.io/github/clok/sm)
[](https://pkg.go.dev/github.com/clok/sm?tab=overview)
> Please see [the docs for details on the commands.](./docs/sm.md)
```text
$ sm --help
NAME:
sm - AWS Secrets Manager CLI Tool
USAGE:
sm [global options] command [command options] [arguments...]
COMMANDS:
get, view select from list or pass in specific secret
edit, e interactive edit of a secret String Value
create, c create new secret in Secrets Manager
put non-interactive update to a specific secret
delete, del delete a specific secret
list display table of all secrets with meta data
describe print description of secret to `STDOUT`
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--help, -h show help (default: false)
--version, -v print the version (default: false)
COPYRIGHT:
(c) 2021 Derek Smith
```
- [Documentation](./docs/sm.md)
- [Authentication](#authentication)
- [Installation](#installation)
- [Homebrew](#homebrewhttpsbrewsh-for-macos-users)
- [curl binary](#curl-binary)
- [docker](#dockerhttpswwwdockercom)
- [Development](#development)
- [Versioning](#versioning)
- [Authors](#authors)
- [License](#license)
## Authentication
This tool uses the [awssession](https://github.com/clok/awssession) module for creating authenticated sessions. This will
use AWS Instance Role, Environment Variables or AWS CLI configuration files to generate a session. This tool should obey
all [AWS CLI Environment Variables](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html).
## Installation
### [Homebrew](https://brew.sh) (for macOS users)
```
brew tap clok/sm
brew install sm
```
### curl binary
```
$ curl https://i.jpillora.com/clok/sm! | bash
```
### [docker](https://www.docker.com/)
The compiled docker images are maintained on [GitHub Container Registry (ghcr.io)](https://github.com/orgs/clok/packages/container/package/sm).
We maintain the following tags:
- `edge`: Image that is build from the current `HEAD` of the main line branch.
- `latest`: Image that is built from the [latest released version](https://github.com/clok/sm/releases)
- `x.y.z` (versions): Images that are build from the tagged versions within Github.
```bash
docker pull ghcr.io/clok/sm
docker run -v "$PWD":/workdir ghcr.io/clok/sm --version
```
### man page
To install `man` page:
```
$ sm install-manpage
```
## Development
1. Fork the [clok/sm](https://github.com/clok/sm) repo
1. Use `go >= 1.16`
1. Branch & Code
1. Run linters :broom: `golangci-lint run`
- The project uses [golangci-lint](https://golangci-lint.run/usage/install/#local-installation)
1. Commit with a Conventional Commit
1. Open a PR
## Versioning
We employ [git-chglog](https://github.com/git-chglog/git-chglog) to manage the [CHANGELOG.md](CHANGELOG.md). For the
versions available, see the [tags on this repository](https://github.com/clok/sm/tags).
## Authors
* **Derek Smith** - [@clok](https://github.com/clok)
See also the list of [contributors](https://github.com/clok/sm/contributors) who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details