Installation

The CLI is only available for private cloud customers

For general users it is recommended to download the binary for your platform. Latest release can be found here: https://github.com/magneticio/forklift/releases/latest‚Äč

Linux and MacOS Users

If you have curl installed, you can install the tool using these commands:

version=$(curl -s https://api.github.com/repos/magneticio/forklift/releases/latest | grep '"tag_name":' | sed -E 's/.*"([^"]+)".*/\1/') &&
base=https://github.com/magneticio/forklift/releases/download/$version &&
curl -sL $base/forklift-$(uname -s)-$(uname -m) >/usr/local/bin/forklift &&
chmod +x /usr/local/bin/forklift

Verify the Installation

Run the following command to verify that the tool is installed correctly:

forklift version

Configuration

File

To configure the tool, you need to create a configuration file that contains the URL of Hashicorp Vault and a Vault token with CRUDL permissions for the intended base path.

The default project and default cluster are optional.

key-value-store-url: http://vault.my-domain:8200
key-value-store-token: s.NotARealToken
key-value-store-base-path: /secret/vamp/
project: 1
cluster: 1

The config file can be passed as part of each command using --config <file> .

Linux and MacOS Users

Alternatively, you can place the configuration in ~/.forklift/config.yaml.

Environment Variables

Environment variables can be used as an alternative to using a config file.

They can also be used in combination with a config file.

When environment variables and a config file are used together, the environment variables override the values in the config file.

VAMP_FORKLIFT_PROJECT
# Vamp Project ID
VAMP_FORKLIFT_CLUSTER
# Vamp Cluster ID
VAMP_FORKLIFT_VAULT_ADDR
# Vault address. Example: http://vault.my-domain:8200
VAMP_FORKLIFT_VAULT_TOKEN
# Vault token
VAMP_FORKLIFT_VAULT_BASE_PATH
# Vault base path. Example: /secret/vamp/
VAMP_FORKLIFT_VAULT_CACERT
# Path of the CA Certificate.
VAMP_FORKLIFT_VAULT_CLIENT_CERT
# Path of the Client Certificate for TLS
VAMP_FORKLIFT_VAULT_CLIENT_KEY
# Path of the Client Certificate Key for TLS