Skip to content

Setting up the VALDI CLI

Note: The VALDI CLI is currently only compatible with Linux-based systems, and has only been tested on Ubuntu. Support for macOS, and then eventually Windows, will be available at a later date.

Install via pip

You can install the VALDI CLI in one step with the following command (preferably within a virtual environment).

python3 -m pip install --upgrade valdi

Run valdi -h to verify that the installation was successful, which should output something like this:

usage: valdi [-h] service ...

positional arguments:
    volume    Manage detachable volumes
    init      Initialize VALDI CLI

optional arguments:
  -h, --help  show this help message and exit

Initialize the CLI

Initialize the CLI with the following command:

valdi init

You must run valdi init for any other commands to work. You need only run this once per installation.