The `dagster-cloud-cli` provides command-line tools for interacting with Dagster Cloud, enabling operations such as deploying code, managing agents, and configuring workspaces. It is the primary interface for developers to manage their Dagster deployments in a Dagster Cloud environment. The current version is 1.13.0, with releases tightly coupled to the broader Dagster ecosystem's frequent update cadence.
pip install dagster-cloud-cliNo compatibility data collected yet for this library.
This quickstart demonstrates how to verify the installation of `dagster-cloud-cli` by running the `dg --version` command. The `dagster-cloud-cli` is primarily a command-line interface tool, and most interactions happen directly in the terminal via the `dg` command. For programmatic interactions with Dagster Cloud itself, the `dagster-cloud` Python library is generally used.
Use `pip install dagster-cloud` and refer to its documentation for Python SDK usage.
Set `export DAGSTER_CLOUD_AGENT_TOKEN='...'` in your environment or run `dg login` to authenticate before executing commands that interact with your Dagster Cloud workspace.
Run `dg init` to set up a new project structure or ensure your existing project contains a valid `dagster_cloud.yaml` file and entrypoint.
Explicitly add `pip install psycopg2-binary` to your project's dependencies if you use `dagster-postgres` and previously relied on its transitive inclusion.
Install the recommended `dagster-dg-cli` using `pip install dagster-dg-cli` and use `dg` commands. If you explicitly need `dagster-cloud`, ensure it's installed via `pip install dagster-cloud` and verify your PATH.
Reauthenticate your CLI session by running `dagster-cloud config setup` or `dg login`. This will guide you through browser-based authentication or prompt for a new user token.
Ensure that a `setup.py` or `requirements.txt` file, listing your project's Python dependencies (including `dagster-cloud`), is present in the root of the directory you are deploying.
Use the specific deployment ID (a long hexadecimal string) when launching jobs in a branch deployment. The deployment ID can be obtained from the Dagster Cloud UI or by running `dagster-cloud ci status` after the deployment.