Skip to content

Latest commit

 

History

History
76 lines (48 loc) · 1.68 KB

usage.md

File metadata and controls

76 lines (48 loc) · 1.68 KB

Usage

Setup

Installation

Brew

brew install dkyanakiev/tap/vaul7y

# to upgrade
brew update && brew upgrade vaul7y

Download from GitHub

Download the relevant binary for your operating system (macOS = Darwin) from the latest Github release. Unpack it, then move the binary to somewhere accessible in your PATH, e.g. mv ./vaul7y /usr/local/bin.

> Using go installed on your machine

go install github.com/dkyanakiev/vaul7y@latest

Building from source and Run Vaul7y

Make sure you have your go environment setup:

  1. Clone the project
  2. Run $ make build to build the binary
  3. Run $ make run to run the binary
  4. You can use $ make install-osx on a Mac to cp the binary to /usr/local/bin/vaul7y

or

$ go install ./cmd/vaul7y

How to use it

Once Vaul7y is installed and avialable in your path, simply run:

$ vaul7y

image

Environment variables

In order to use the tool you must expose the needed env variables, that would generally be used by the vault cli to auth to a given cluster.

Required:
VAULT_ADDR
VAULT_TOKEN

For the full list see the official docs

Features

Currently the capabilities are limited.

  • Support for navigation between KV mounts
    • Currently only KV2
  • Looking up secret objects
    • Show/hide secrets and coping data
    • Update/patch coming soon
  • Support for exploring and filtering ACL Policies

Note: Currently only supporting default namespace. Will implement the namespace change fairly soon.