Back to docs
Getting Started

Installation

Install the Dagy SDK and configure your environment.

Prerequisites

  • Python 3.10 or later
  • pip (or uv for faster installs)
  • AWS credentials configured (required only for deployment and remote execution)

Install the SDK

From the project root:

pip install .

This installs the dagy CLI and the Python SDK. Core dependencies (boto3, duckdb, pyyaml, tabulate) are installed automatically.

Development install

For local development with test and lint tools:

pip install -e ".[dev]"

API server dependencies

If you're running the Dagy API server locally:

pip install -e ".[api]"

Documentation dependencies

For building the docs site:

pip install -e ".[docs]"

Verify the installation

dagy --help

You should see a list of available commands: build, config, deploy, flows, login, logout, logs, run, and runs.

Initial configuration

Set up your first profile to connect to a Dagy API:

dagy config

This launches an interactive wizard that prompts for a profile name, API URL, and table format preference. See Profiles for details.

Authenticate

Log in to your Dagy account:

dagy login

This opens your browser for OAuth authentication. Once complete, the token is stored locally at ~/.dagy/credentials.

Next steps