dg reference
warning
This feature is considered in a preview stage and is under active development. It can change significantly, or be removed completely. It is not considered ready for production use.
Below is the help message for dg, which also serves as the API reference:
dg --help
Usage: dg [OPTIONS] COMMAND [ARGS]...
CLI for working with Dagster components.
╭─ Options ─────────────────── ───────────────────────────────────────────────────────────╮
│ --clear-cache Clear the cache. │
│ --rebuild-component-registry Recompute and cache the set of available │
│ component types for the current environment. │
│ Note that this also happens automatically │
│ whenever the cache is detected to be stale. │
│ --install-completion Automatically detect your shell and install a │
│ completion script for the `dg` command. This │
│ will append to your shell startup file. │
│ --version -v Show the version and exit. │
│ --help -h Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Global options ───────────────────────────────────────────────────────────────────────╮
│ --require-local-venv --no-require-local-venv Require use of a local │
│ virtual environment │
│ (`.venv` found in │
│ ancestors of the working │
│ directory). │
│ --use-dg-managed-enviro… --no-use-dg-managed-en… Enable management of the │
│ virtual environment with │
│ uv. │
│ --verbose Enable verbose output for │
│ debugging. │
│ --disable-cache Disable the cache.. │
│ --cache-dir TEXT Specify a directory to │
│ use for the cache. │
╰────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────────────────╮
│ check Commands for checking the integrity of your Dagster code. │
│ dev Start a local instance of Dagster. │
│ docs Commands for generating docs from your Dagster code. │
│ init Initialize a new Dagster workspace and a first project within that │
│ workspace. │
│ launch Launch a Dagster run. │
│ list Commands for listing Dagster entities. │
│ scaffold Commands for scaffolding Dagster code. │
│ utils Assorted utility commands. │
╰────────────────────────────────────────────────────────────────────────────────────────╯