Install & Compatibility
Where this runs
tested against v0.20.24 · 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.915 runs
installs and imports cleanly · install 0.0s · import 0.000s · 136.3MB
glibcpy 3.10–3.915 runs
installs and imports cleanly · install 11.5s · import 0.000s · 137MB
135MB installed
● package 135MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
Client
✓ from dstack import Client
✗ from dstack import Client
This quickstart demonstrates how to instantiate the dstack Python client and make a basic API call to verify connectivity and authentication by fetching the user's profile and listing projects. It assumes the dstack server URL and API key are configured via environment variables or the dstack CLI config file.
import os
from dstack.client import Client
# Configure dstack client via environment variables (DSTACK_URL, DSTACK_API_KEY)
# or the dstack config file (~/.dstack/config.yaml). For a runnable example,
# ensure these are set.
# Example: export DSTACK_URL="https://your-dstack-server.com"
# Example: export DSTACK_API_KEY="ds_your_api_key_here"
try:
client = Client()
# Attempt a simple API call to verify connection and authentication
user_profile = client.get_profile() # Requires an authenticated client
print(f"Successfully connected to dstack server as user: {user_profile.name} (ID: {user_profile.id})")
# Example: List available projects
projects = client.projects()
print(f"Found {len(projects)} projects:")
for project in projects:
print(f"- {project.name} (ID: {project.id})")
except Exception as e:
print(f"Error connecting to dstack or fetching data: {e}")
print("Please ensure your dstack server URL (DSTACK_URL) and API Key (DSTACK_API_KEY) are correctly configured in your environment or dstack config file.")
dstack --version
Debug
Known issues
breakingConfiguration for Prefill-Decode (PD) disaggregation with SGLang changed in version 0.20.17.fixIf you are using SGLang with PD disaggregation, you must now configure the `router` property on the service replica group instead of on the gateway. Consult the updated documentation for service configuration examples.
affects: >=0.20.17
gotchadstack relies on proper authentication and server URL configuration. Client instantiation or API calls will fail without these.fixEnsure `DSTACK_URL` and `DSTACK_API_KEY` environment variables are set, or configure them using the `dstack config set --url <URL> --key <KEY>` CLI command.
affects: All versions
gotchaThe YAML configuration schema for dstack resources (fleets, services, dev environments) can evolve between minor versions.fixAlways consult the official dstack documentation or release notes when upgrading to a new version to understand any changes to the YAML configuration format for your existing deployments.
affects: All versions (especially across minor updates)
Upgrade
Version history
0.20.24latest on PyPI · released Jun 11, 2026
Audit
Dependencies
No dependency data recorded yet.