Install & Compatibility
Where this runs
tested against v1.13.20 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslpy 3.10–3.95 runs
installs and imports cleanly · install 0.0s · import 3.316s · 191.4MB
glibcpy 3.10–3.95 runs
installs and imports cleanly · install 18.6s · import 3.142s · 187MB
198MB installed
● package 198MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
DagsterCloudAgentInstance
✓ from dagster_cloud import DagsterCloudAgentInstance
✗ from dagster_cloud import DagsterCloudClient
CloudComputeLogManager
✓ from dagster_cloud import CloudComputeLogManager
DagsterLibraryRegistry
✓ from dagster_cloud import DagsterLibraryRegistry
This quickstart demonstrates how to initialize the `DagsterCloudClient` and use it to interact with your Dagster Cloud organization. It retrieves and prints the names of all available workspaces. Ensure `DAGSTER_CLOUD_ORGANIZATION_ID` and `DAGSTER_CLOUD_API_TOKEN` environment variables are set for authentication.
import os
from dagster_cloud.client import DagsterCloudClient
# Ensure these environment variables are set:
# DAGSTER_CLOUD_ORGANIZATION_ID
# DAGSTER_CLOUD_API_TOKEN
organization_id = os.environ.get('DAGSTER_CLOUD_ORGANIZATION_ID', 'your_org_id_here')
api_token = os.environ.get('DAGSTER_CLOUD_API_TOKEN', 'your_api_token_here')
if not organization_id or not api_token:
print("Error: DAGSTER_CLOUD_ORGANIZATION_ID and DAGSTER_CLOUD_API_TOKEN must be set.")
exit(1)
try:
client = DagsterCloudClient(
organization_id=organization_id,
api_token=api_token
)
# Example: List available workspaces
workspaces = client.get_workspaces()
print(f"Found {len(workspaces)} workspaces in Dagster Cloud:")
for ws in workspaces:
print(f"- {ws.name} (ID: {ws.id})")
except Exception as e:
print(f"An error occurred: {e}")
dagster-cloud --version
Debug
Known issues
gotchaAuthentication to Dagster Cloud requires setting `DAGSTER_CLOUD_ORGANIZATION_ID` and `DAGSTER_CLOUD_API_TOKEN` environment variables. Without these, client initialization will fail or lead to unauthorized access errors.fixSet `DAGSTER_CLOUD_ORGANIZATION_ID` and `DAGSTER_CLOUD_API_TOKEN` in your environment. API tokens can be generated in the Dagster Cloud UI.
affects: All versions
breakingThe `dagster-cloud` library must be compatible with the core `dagster` library. Significant version mismatches (e.g., pre-1.0 `dagster` with 1.x `dagster-cloud`) can lead to import errors, runtime exceptions, or unexpected behavior due to API changes and data model evolution.fixAlways install `dagster` and `dagster-cloud` within the same major version range. Refer to the official Dagster documentation for version compatibility guidelines.
affects: All versions, particularly across major `dagster` versions (e.g., 0.x to 1.x)
gotchaChanges to deployment models (e.g., agent-based, hybrid, serverless) often require updates to `dagster-cloud` configuration or even CLI commands. Relying on outdated deployment patterns with newer `dagster-cloud` versions can lead to deployment failures or inefficiencies.fixRegularly review the Dagster Cloud deployment documentation and ensure your deployment configuration and `dagster-cloud` CLI usage align with the recommended patterns for your chosen deployment model.
affects: Versions 0.x through 1.x, particularly around features like serverless deployments.
Upgrade
Version history
1.13.20latest on PyPI · released Aug 27, 2026
Audit
Dependencies
dagsterrequiredProvides core Dagster functionality; dagster-cloud builds on and extends it for cloud deployments.