lorenzodisidoro / avocado-cli

🥑 Avocado is a small surface command line interface to use Avocado SDK, it can be used to encrypt your secrets with RSA key

Avocado CLI

Avocado is a small surface command line interface to use Avocado SDK, it can be used to manage your passwords with RSA key.

Supported OS

• OSX
• Linux

Installation

Generate your RSA key pair (e.g. using ssh-keygen tool) and run the following command to install Avocado CLI

curl https://raw.githubusercontent.com/lorenzodisidoro/avocado-cli/master/scripts/install_cli.sh | bash

or specify the version tag of the CLI

curl https://raw.githubusercontent.com/lorenzodisidoro/avocado-cli/master/scripts/install_cli.sh | bash -s VERSION_TAG

After that try to run the following command

$ avocado

Getting Started

Configuration

Before using Avocado CLI, you need to generate an RSA private key, for example running:

openssl genrsa -out private_key.pem

After that inizialize the CLI configuration file config.json, running the following command

avocado init </PATH/TO/PRIVATE_KEY.pem>

The CLI creates and reads this file in $HOME/.avocado/ directory.

How to use

Encrypt

A new value can be encrypted and stored using the following command

avocado encrypt <KEY>

Get

Print the stored elements

avocado get

Decrypt

Stored values can be decrypted using the following command

avocado decrypt <KEY> </PATH/TO/PRIVATE_KEY.pem>

decrypted value is written in to the clipboard.

Delete

Remove element by key

avocado delete <KEY>

For Developers

Clone this repository into your $GOPATH using

git clone https://github.com/lorenzodisidoro/avocado-cli

moved to the project folder install dependencie with

go mod tidy

The application can be used running

go run main.go [command]

or create a build and use it

./scripts/build.sh <GOOS> <GOARCH>

You can build this applications for different Operating Systems and architectures (To find this list of possible platforms, run the following: go tool dist list)