Entropy Data

Entropy Data CLI

The Entropy Data CLI is experimental. Commands and options may change in future releases.

The Entropy Data CLI is a command-line tool for interacting with the Entropy Data platform. It allows you to manage data products, data contracts, access agreements, teams, source systems, definitions, certifications, tags, assets, and more — directly from your terminal or CI/CD pipeline. The CLI is written in Python and can be used standalone or integrated into scripts and automation pipelines.

Installation

Requires Python 3.11 or newer.

Install with uv (recommended):

uv tool install entropy-data
entropy-data --help

Or with pip:

pip install entropy-data
entropy-data --help

Docker

docker run --rm entropy-data/cli --help

Configuration

The CLI supports three ways to provide credentials, in order of precedence:

  1. CLI options (--api-key, --host)
  2. Environment variables or a .env file (ENTROPY_DATA_API_KEY, ENTROPY_DATA_HOST)
  3. A named connection in ~/.entropy-data/config.toml

Connections

Generate an API key in the Entropy Data UI under organization settings, then add a connection:

entropy-data connection add prod
# prompts for API key and host

Connections are stored in ~/.entropy-data/config.toml:

default_connection_name = "prod"

[connections.prod]
api_key = "ed_abc123..."
host = "https://api.entropy-data.com"

[connections.dev]
api_key = "ed_xyz789..."
host = "https://localhost:8080"

Switch the active connection with --connection:

entropy-data --connection dev dataproducts list

Manage connections:

entropy-data connection list
entropy-data connection set-default prod
entropy-data connection test
entropy-data connection remove dev

Environment Variables

export ENTROPY_DATA_API_KEY="your-api-key"
export ENTROPY_DATA_HOST="https://app.entropy-data.com"

.env File Support

The CLI automatically loads a .env file from the current working directory:

.env

ENTROPY_DATA_API_KEY=your-api-key
ENTROPY_DATA_HOST=https://app.entropy-data.com

Values from .env do not override already-set environment variables.

CLI Options

entropy-data --api-key your-api-key --host https://app.entropy-data.com <command>

Usage

Explore your data platform

# List teams
entropy-data teams list

# Get a specific data product
entropy-data dataproducts get my-data-product

# List data contracts as JSON
entropy-data datacontracts list --output json

Manage resources

# Create or update a team from a YAML file
entropy-data teams put marketing --file team.yaml

# Approve an access agreement
entropy-data access approve 640864de-83d4-4619-afba-ccea8037ed3a

# Search across all resources
entropy-data search query "customer orders"

Commands

entropy-data [--version] [--connection NAME] [--output table|json] [--debug]

  connection      list | add | remove | set-default | test
  dataproducts    list | get | put | delete
  datacontracts   list | get | put | test | delete
  access          list | get | put | delete | approve | reject | cancel
  teams           list | get | put | delete
  sourcesystems   list | get | put | delete
  definitions     list | get | put | delete
  certifications  list | get | put | delete
  example-data    list | get | put | delete
  test-results    list | get | publish | delete
  costs           list | add | delete
  assets          list | get | put | delete
  tags            list | get | put | delete
  api-keys        create | delete
  settings        get-customization | put-customization
  events          poll
  lineage         list | submit | delete
  search          query
  usage           list | submit | delete
  import          zip