Skip to content

Installation Guide

To use the OpenAleph CLI and Python library, you'll need to install the openaleph package.

Prerequisites

  • Python 3.6 or higher
  • pip (Python package installer)

We recommend that you use a virtual environment.

Installation Steps

  1. Install the package:

    pip install openaleph

  2. Verify the installation:

    openaleph --help

    This command should display the help information for the OpenAleph CLI.

a screenshot of the openaleph help page

You're now ready to use the OpenAleph CLI and Python library.

  1. Optional: Add environmet variables

    The openaleph cli uses environment variables to read the host of the OpenAleph instance you want to interact with, as well as the API key.

    Store this information in your shells rc file or export it before you use openaleph

    export OPAL_API_KEY=your_api_key
export OPAL_HOST=https://your-aleph-instance.org

    Alternatively, you can pass these values on the fly using the --host and --api-key options.

Move to the next chapter to learn how openaleph is used from the command line.