kp

KP

A terminal tool to manage key/pairs.

This is OSS - if you want to contribute please read the DEVELOPER_GUIDE.md.

Install

Install via go get

go get github.com/simonski/kp

This will install kp onto your $GOBIN. Please ensure $GOBIN is on your $PATH.

Setup

Once you've installed kp and can type kp version, you will need to configure kp.

kp verify

By default, kp stores keypairs to a ~/.kpfile. This can be controlled with the environment variable KP_FILE

Encryption

The ~/.kpfile itself is plaintext, the password is encrypted.

Create your encryption key

ssh-keygen -b 2048 -t rsa -N "" -m pkcs8 -f ~/.ssh/kp.id_rsa

Or re-use one? - up to you:

export KP_KEY=~/path/to/id_rsa

Finally, confirm kp is setup properly:

kp verify

Assuming you get a "KP is setup correctly." message, you can then use kp in the following manner - if you don't, it will explain what needs changing in the verify command itself.

Usage

Store a key/value

kp put <keyname>
>> STDIN value

Store a key/value (but dont overwrite)

kp put <keyname> -no-overwrite
>> STDIN value

Retrieve the value of a key to your clipboard

kp get <keyname>

List all keys

kp ls

List all keys (including hidden)

kp ls -a

Search for an entry

kp ls widget

Update a key

kp update <key> 
 -type         "type"
 -url          "url"
 -username     "username"
 -description  "description"
 -notes        "notes"

Remove a key

kp rm <keyname>

Get help on any command:

kp

Hide a key

kp hide <keyname>

Show the key

kp show <keyname>

Environment variables

kp tries to run with sensible defaults. You can override them using the following envinronment variables:

Releases

I use github actions to create a crossplatform release binary on a tag.