Installing Dagster
To follow the steps in this guide, you'll need:
- To install Python 3.9 or higher. Python 3.12 is recommended.
Recommended: Creating a new project with create-dagster
The recommended way to get started with Dagster is to create a project using the create-dagster
command line utility. This will scaffold a Dagster project with our recommended structure and required dependencies.
Using create-dagster
The create-dagster
utility can be installed with Homebrew or curl
, or invoked without installation using uvx
.
- uvx (Recommended)
- Homebrew
- curl
First, install the Python package manager uv
if you don't have it.
This will also install the uvx
command, which allows you to execute commands without having to install packages directly.
- Mac
- Windows
- Linux
brew install uv
powershell -ExecutionPolicy ByPass -c 'irm https://astral.sh/uv/install.ps1 | iex'
curl -LsSf https://astral.sh/uv/install.sh | sh
For more detailed uv
installation instructions, see the uv
docs.
Now, you can run the create-dagster
command using uvx
:
uvx create-dagster project my-project
create-dagster
is available in a Homebrew tap:
brew install dagster-io/tap/create-dagster
After installation, run the create-dagster
command:
create-dagster project my-project
Use curl
to download a standalone installation script and execute it with sh
:
curl -LsSf https://dg.dagster.io/create-dagster/install.sh | sh
Then run the create-dagster
command:
create-dagster project my-project
Alternative: Manual installation in a virtual environment
If you prefer to set up Dagster manually or are installing it into an existing project, you can install Dagster directly into your Python environment.
Installing Dagster
- uv
- pip
uv add dagster dagster-webserver dagster-dg-cli
pip install dagster dagster-webserver dagster-dg-cli
Verifying your project
To verify that Dagster is installed correctly, run the following command:
- Mac
- Windows
- Linux
cd my-project
source .venv/bin/activate
dg --version
cd my-project
.venv\Scripts\activate
dg --version
cd my-project
source .venv/bin/activate
dg --version
You should be presented with the version number of dg
in your environment.
Troubleshooting
If you encounter any issues during the installation process:
- Refer to the Dagster GitHub repository for troubleshooting, or
- Reach out to the Dagster community
Next steps
- Get up and running with your first Dagster project in the Quickstart
- Learn more about the
dg
CLI and modern Dagster development - Learn to create data assets in Dagster