dg utils reference
dg utils
Assorted utility commands.
dg utils [OPTIONS] COMMAND [ARGS]...
configure-editor
Generates and installs a VS Code or Cursor extension which provides JSON schemas for Components types specified by YamlComponentsLoader objects.
dg utils configure-editor [OPTIONS] {vscode|cursor}
Options:
- --target-path <target_path>
Specify a directory to use to load the context for this command. This will typically be a folder with a dg.toml or pyproject.toml file in it.
- --verbose
Enable verbose output for debugging.
Arguments:
- EDITOR
Required argument
generate-component-schema
Generates a JSON schema for the component types installed in the current project.
dg utils generate-component-schema [OPTIONS]
Options:
- --verbose
Enable verbose output for debugging.
inspect-component
Get detailed information on a registered Dagster component type.
dg utils inspect-component [OPTIONS] COMPONENT_TYPE
Options:
- --defs-yaml-schema
Generate LLM-optimized YAML template with inline documentation and type hints. Unlike JSON schemas designed for validation, this YAML format includes human-readable annotations and structured documentation that LLMs can better parse and understand. Includes Required/Optional annotations, plain English type descriptions, field descriptions inline with properties, and serves as both documentation and code generation scaffold optimized for AI consumption.
- --defs-yaml-example-values
Generate YAML example values optimized for LLM understanding and code generation
- --target-path <target_path>
Specify a directory to use to load the context for this command. This will typically be a folder with a dg.toml or pyproject.toml file in it.
- --verbose
Enable verbose output for debugging.
Arguments:
- COMPONENT_TYPE
Required argument
refresh-defs-state
Refresh the defs state for the current project.
dg utils refresh-defs-state [OPTIONS]
Options:
- --target-path <target_path>
Specify a directory to use to load the context for this command. This will typically be a folder with a dg.toml or pyproject.toml file in it.
- --verbose
Enable verbose output for debugging.
- --defs-state-key <defs_state_key>
Only refresh state for specified defs state key. Can be specified multiple times.
- --management-type <management_type>
Only refresh components with the specified management type. Can be specified multiple times to include multiple types. Defaults to all management types except for LEGACY_CODE_SERVER_SNAPSHOTS.
Options: LOCAL_FILESYSTEM | VERSIONED_STATE_STORAGE