Skip to content

CLI Installation

This guide covers how to install the dagctl CLI tool on your local machine.

SQLMesh users only

The dagctl CLI is only required for SQLMesh projects where you want to connect your local development environment to the dagctl-managed state database. dbt projects are fully managed through the web UI and do not require the CLI.

Prerequisites

  • Python 3.8 or higher
  • pip package manager

Installing dagctl

Install the latest version of dagctl from PyPI:

pip install dagctl

For Python 3 specifically:

pip3 install dagctl

Install Specific Version

To install a specific version:

pip install dagctl==1.0.0

Verify Installation

Confirm dagctl is installed correctly:

dagctl --version

You should see output like:

dagctl version 1.0.0

Check available commands:

dagctl --help

Upgrading dagctl

To upgrade to the latest version:

pip install --upgrade dagctl

We recommend using a virtual environment to avoid conflicts with other Python packages.

Using venv

# Create virtual environment
python -m venv dagctl-env

# Activate (Linux/Mac)
source dagctl-env/bin/activate

# Activate (Windows)
dagctl-env\Scripts\activate

# Install dagctl
pip install dagctl

Using conda

# Create environment
conda create -n dagctl python=3.11

# Activate
conda activate dagctl

# Install dagctl
pip install dagctl

System-Wide Installation

For system-wide installation on Linux/Mac:

sudo pip install dagctl

Warning

System-wide installation is not recommended as it can cause conflicts with system packages. Use virtual environments instead.