Skip to content

Commit

Permalink
Installation instructions (#58)
Browse files Browse the repository at this point in the history
  • Loading branch information
fishi0x01 authored Jan 18, 2021
1 parent 8649de4 commit b04299c
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,38 @@
![vsh usage](https://user-images.githubusercontent.com/10799507/66355982-9872a980-e969-11e9-8ca4-6a2ff215f835.gif)

`vsh` is an interactive [HashiCorp Vault](https://www.vaultproject.io/) shell which treats paths and keys like directories and files.
Key features are:
Core features are:

- recursive operations on paths with `cp`, `mv` or `rm`
- term search with `grep`
- transparency towards differences between KV1 and KV2, i.e., you can freely move/copy secrets between both
- non-interactive mode for automation (`vsh -c "<cmd>"`)
- merging keys with different strategies through `append`

## Installation

### MacOS / Brew

```sh
brew install vsh
```

### Nix

```sh
nix-env -i vsh
```

### Static binaries for Linux / MacOS

E.g., install to `/usr/local/bin`:

```sh
sudo curl -sLo /usr/local/bin/vsh https://github.com/fishi0x01/vsh/releases/download/v0.7.2/vsh_$(uname | tr '[:upper:]' '[:lower:]')_amd64
```

It is recommendable to verify [checksums](https://github.com/fishi0x01/vsh/releases/download/v0.7.2/SHA256SUM) for data integrity.

## Supported commands

```text
Expand Down

0 comments on commit b04299c

Please sign in to comment.