Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shahradelahi/vault-cli
A CLI for HashiCorp Vault Key/Vault V2 secret engines
https://github.com/shahradelahi/vault-cli
cli hashicorp kv2 nodejs vault
Last synced: 7 days ago
JSON representation
A CLI for HashiCorp Vault Key/Vault V2 secret engines
- Host: GitHub
- URL: https://github.com/shahradelahi/vault-cli
- Owner: shahradelahi
- License: gpl-3.0
- Created: 2023-11-26T16:15:52.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-28T21:11:03.000Z (13 days ago)
- Last Synced: 2024-12-30T15:16:24.673Z (11 days ago)
- Topics: cli, hashicorp, kv2, nodejs, vault
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/kvault
- Size: 231 KB
- Stars: 181
- Watchers: 3
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vault CLI (kvault)
[](https://github.com/shahradelahi/vault-cli/actions)
[](https://www.npmjs.com/package/kvault)
[](https://packagephobia.com/result?p=kvault)
[](https://www.npmjs.com/package/kvault)
_kvault_ is a CLI for managing HashiCorp Vault Key/Value V2 secret engines from the command line.
---
- [Installation](#-installation)
- [Usage](#-usage)
- [Make Profile](#make-profile)
- [Push](#push)
- [Pull](#pull)
- [Remove](#rm)
- [Pipe](#pipe)
- [Contributing](#-contributing)
- [License](#license)
## 📦 Installation
```bash
npx kvault --help # Or bunx kvault --help
```
###### Make it global
```bash
npm install --global kvault
```
## 📖 Usage
```text
Usage: kvault [options] [command]
Manage your HashiCorp Vault Key/Value v2 secret engines from the command line.
Author: Shahrad Elahi (https://github.com/shahradelahi)
License: GPL-3.0
Options:
-v, --version display the version number
-h, --help display help for command
Commands:
make-profile [options] Create a new vault profile
mount [options] Mount a new KV2 secret engine
pipe [options] [command...] Pull an environment from Vault and pipe it to a command
push [options] Push an environment to Vault
pull [options] Pull an environment from Vault
rm [options] [versions...] Remove a secret from Vault
seal [options] Seal Vault
unmount [options] Unmount a secret engine
unseal [options] [keys...] Unseal Vault
help [command] display help for command
```
### make-profile
This command will create a profile in your home directory. It will be used to store your Vault's address and token.
#### Options
```txt
Usage: kvault make-profile [options]
Create a new vault profile
Options:
--endpoint-url Vault endpoint URL
--token Vault token
--force Overwrite existing profile (default: false)
-h, --help display help for command
```
###### Examples
```bash
# Create a new profile
kvault make-profile my-profile --endpoint-url https://vault.example.com --token my-token
```
### push
This command will push a secret to your Vault.
#### Options
```txt
Usage: kvault push [options]
Push an environment to Vault
Options:
-P, --profile Name of the profile to use.
--endpoint-url Vault endpoint URL
--token Vault token
--cwd Current working directory (default: ".")
--force Write to Vault even if the secrets are in conflict (default: false)
-h, --help display help for command
```
###### Examples
```bash
# Push a .env.local file to Vault
kvault push --profile my-profile .env.local secret/my-app
# Use credentials instead of a profile
kvault push --endpoint-url https://vault.example.com --token my-token .env.local secret/my-app
```
### pull
This command will pull a secret from your Vault.
#### Options
```txt
Usage: kvault pull [options]
Pull an environment from Vault
Options:
-P, --profile Name of the profile to use.
--endpoint-url Vault endpoint URL
--token Vault token
-O, --output-file Path to write the environment file to
-F, --format Format of the environment file (default: "dotenv")
--cwd Current working directory (default: ".")
--force Write environment file even if it exists (default: false)
-h, --help display help for command
```
###### Examples
```bash
# Pull a secret from Vault
kvault pull --profile my-profile secret/my-app
# Pull a secret from Vault and save it to a .env file
kvault pull --profile my-profile secret/my-app --env-path .env
# Pull a secret from Vault and add them to shell environment
kvault pull --profile my-profile secret/my-app --format shell | grep -e '^export' | source /dev/stdin
```
### pipe
This command will pull and pipe secrets from your Vault to another command.
#### Options
```txt
Usage: kvault pipe [options] [command...]
Pull an environment from Vault and pipe it to a command
Arguments:
secrets-path
command Command to pipe to (default: [])
Options:
-P, --profile Name of the profile to use.
--endpoint-url Vault endpoint URL
--token Vault token
--cwd Current working directory (default: ".")
-h, --help display help for command
```
###### Examples
```bash
# Pull a secret from Vault and pipe it to a command
kvault pipe --profile my-profile secret/my-app env | grep -e '^MY_APP_'
# Pull a secret from Vault and pipe it to a node script
kvault pipe --profile my-profile secret/my-app "node -e 'console.log(process.env.MY_APP_SECRET)'"
```
### rm
This command will remove a path or some versions of a secret.
#### Options
```txt
Usage: kvault rm [options] [versions...]
Remove a secret from Vault
Arguments:
secrets-path
versions Versions to remove. By default, path will be removed. (default: [])
Options:
-P, --profile Name of the profile to use
--endpoint-url Vault endpoint URL
--token Vault token
--force Remove the secret without confirmation (default: false)
-h, --help display help for command
```
###### Examples
```bash
# Remove a path secret from Vault
kvault rm --profile my-profile secret/my-app
# Remove a secret version from Vault
kvault rm --profile my-profile secret/my-app 3 4
```
## 🤝 Contributing
Want to contribute? Awesome! To show your support is to star the project, or to raise issues on [GitHub](https://github.com/shahradelahi/vault-cli).
Thanks again for your support, it is much appreciated!
### License
[GPL-3.0](LICENSE) © [Shahrad Elahi](https://github.com/shahradelahi)