Holistics CLI

Beta

The Holistics CLI is currently in beta. Some features may not be available or may be unstable.

Introduction

The Holistics CLI tool provides a powerful tooling to interact with Holistics services. This tool allows developers and analysts to integrate Holistics capabilities directly into their analytics development pipeline.

With the Holistics CLI, you can:

• Compile AML files into JSON objects
• Validate AML repositories for errors
• Integrate and upload dbt models

The CLI tool is a self-contained binary that does not require installing any additional dependencies.

Installation

For macOS and Linux

Run the following command to install the Holistics CLI:

curl -fsSL https://raw.githubusercontent.com/holistics/holistics-cli/refs/heads/master/install.sh | bash

Note:

The installation script supports bash, zsh, and fish. If you are using other shells, please update PATH to include ~/.holistics/bin.

For Windows

Note:

At the moment, we do not have an installation script for Windows. Please manually download the latest release, then add it to your Path in the Environment Variables.

Authentication

Retrieve your API Key as described here.

Then, run the following command to authenticate:

holistics auth <your-api-key>

Your API Key will be saved in ~/.holistics.yml. Subsequent commands that require authentication with Holistics will use this API Key to authenticate.

Important - Invalid Authentication Token error

By default, the CLI connects to the Asia-Pacific servers. If your account is in another server (EU or US), you will have to specify the HOLISTICS_HOST environment variable in your authentication command.

👉 If you are not sure what server you are on, please follow this guide to find out.

Assuming you are in EU server (https://eu.holistics.io), the command will now become:

HOLISTICS_HOST=https://eu.holistics.io holistics auth <your-api-key>

You will need to prepend every command with HOLISTICS_HOST=https://eu.holistics.io.

Alternatively, specify it only once as a global variable by running:

export HOLISTICS_HOST=https://eu.holistics.io

And you can run the commands without prepending the host everytime.

Quick Start

Upload a dbt model

To upload a dbt model, you need to have a manifest JSON file.

For example, to upload manifest.json to data source demodb, run the following command:

holistics dbt upload --file-path manifest.json --data-source demodb

Compile AML files

Note:

In order to compile AML files, the current working directory must be the root directory of a valid AML repository.

To compile AML models, run the following command:

holistics aml compile **/*.model.aml

Modules Overview

The Holistics CLI is organized into several modules, each with its own set of commands and options.

Module	Description
auth	Authentication commands
aml	AML-related commands
dbt	dbt-related commands