About CLI

The Prelude Command Line Interface (CLI) supplies programmatic access to the full suite of Prelude APIs. It is written in Python and will run on any machine with Python installed.

Run the following command to install the Prelude CLI:

pip3 install prelude-cli

# Confirm it's installed correctly
prelude --help

If you have an older version of the Prelude CLI, run the following command to update to the latest version:

pip3 install prelude-cli --upgrade

Once installed, you can engage the CLI through the prelude command.

The CLI reads credentials from a ~/.prelude/keychain.ini file, which auto-generates when creating an account.

If you do not have a Prelude Account, you can create one by running prelude iam create-account. If you are using the web-based UI and already have a Prelude Account, you can import your existing credentials by running prelude configure. This command will request that you provide your account credentials, which you can retrieve from the web-based UI's top-right menu action "Export credentials." That action will save a credentials file (by default named keychain.ini) to the location you select.