Dagster CLI¶

dagster asset¶

Commands for working with Dagster assets.

dagster asset [OPTIONS] COMMAND [ARGS]...

Commands

list: List assets

materialize: Execute a run to materialize a selection…

wipe: Eliminate asset key indexes from event logs.

wipe-partitions-status-cache: Clears the asset partitions status cache,…

dagster debug¶

Commands for helping debug Dagster issues by dumping or loading artifacts from specific runs.

This can be used to send a file to someone like the Dagster team who doesn’t have direct access to your instance to allow them to view the events and details of a specific run.

Debug files can be viewed using dagster-webserver-debug cli. Debug files can also be downloaded from the Dagster UI.

dagster debug [OPTIONS] COMMAND [ARGS]...

Commands

export: Export the relevant artifacts for a job…

import: Import the relevant artifacts from debug…

dagster definitions validate¶

The dagster definitions validate command loads and validate your Dagster definitions using a Dagster instance.

This command indicates which code locations contain errors, and which ones can be successfully loaded. Code locations containing errors are considered invalid, otherwise valid.

When running, this command sets the environment variable DAGSTER_IS_DEFS_VALIDATION_CLI=1. This environment variable can be used to control the behavior of your code in validation mode.

This command returns an exit code 1 when errors are found, otherwise an exit code 0.

This command should be run in a Python environment where the dagster package is installed.

dagster definitions validate [OPTIONS]

Options

--log-format <log_format>¶

Format of the logs for dagster services

Default:: 'colored'
Options:: colored | json | rich

--log-level <log_level>¶

Set the log level for dagster services.

Default:: 'info'
Options:: critical | error | warning | info | debug

-w, --workspace <workspace>¶: Path to workspace file. Argument can be provided multiple times.

-f, --python-file <python_file>¶: Specify python file or files (flag can be used multiple times) where dagster definitions reside as top-level symbols/variables and load each file as a code location in the current python environment.

-m, --module-name <module_name>¶: Specify module or modules (flag can be used multiple times) where dagster definitions reside as top-level symbols/variables and load each module as a code location in the current python environment.

Environment variables

DAGSTER_PYTHON_FILE: Provide a default for --python-file

DAGSTER_MODULE_NAME: Provide a default for --module-name

dagster dev¶

Start a local deployment of Dagster, including dagster-webserver running on localhost and the dagster-daemon running in the background

dagster dev [OPTIONS]

Options

-d, --working-directory <working_directory>¶: Specify working directory to use when loading the repository or job

-m, --module-name <module_name>¶: Specify module or modules (flag can be used multiple times) where dagster definitions reside as top-level symbols/variables and load each module as a code location in the current python environment.

-f, --python-file <python_file>¶: Specify python file or files (flag can be used multiple times) where dagster definitions reside as top-level symbols/variables and load each file as a code location in the current python environment.

-w, --workspace <workspace>¶: Path to workspace file. Argument can be provided multiple times.

--code-server-log-level <code_server_log_level>¶

Set the log level for code servers spun up by dagster services.

Default:: 'warning'
Options:: critical | error | warning | info | debug

--log-level <log_level>¶

Set the log level for dagster services.

Default:: 'info'
Options:: critical | error | warning | info | debug

--log-format <log_format>¶

Format of the logs for dagster services

Default:: 'colored'
Options:: colored | json | rich

-p, --port, --dagit-port <port>¶: Port to use for the Dagster webserver.

-h, --host, --dagit-host <host>¶: Host to use for the Dagster webserver.

--live-data-poll-rate <live_data_poll_rate>¶

Rate at which the dagster UI polls for updated asset data (in milliseconds)

Default:: '2000'

Environment variables

DAGSTER_WORKING_DIRECTORY: Provide a default for --working-directory

DAGSTER_MODULE_NAME: Provide a default for --module-name

DAGSTER_PYTHON_FILE: Provide a default for --python-file

dagster instance¶

Commands for working with the current Dagster instance.

dagster instance [OPTIONS] COMMAND [ARGS]...

Commands

concurrency: Commands for working with the…

info: List the information about the current…

migrate: Automatically migrate an out of date…

reindex: Rebuild index over historical runs for…

dagster job¶

Commands for working with Dagster jobs.

dagster job [OPTIONS] COMMAND [ARGS]...

Commands

backfill: Backfill a partitioned job.

execute: Execute a job.

launch: Launch a job using the run launcher…

list: List the jobs in a repository.

print: Print a job.

scaffold_config: Scaffold the config for a job.

dagster run¶

Commands for working with Dagster job runs.

dagster run [OPTIONS] COMMAND [ARGS]...

Commands

delete: Delete a run by id and its associated…

list: List the runs in the current Dagster…

migrate-repository: Migrate the run history for a job from a…

wipe: Eliminate all run history and event logs.

dagster schedule¶

Commands for working with Dagster schedules.

dagster schedule [OPTIONS] COMMAND [ARGS]...

Commands

debug: Debug information about the scheduler.

list: List all schedules that correspond to a…

logs: Get logs for a schedule.

preview: Preview changes that will be performed by…

restart: Restart a running schedule.

start: Start an existing schedule.

stop: Stop an existing schedule.

wipe: Delete the schedule history and turn off…

dagster sensor¶

Commands for working with Dagster sensors.

dagster sensor [OPTIONS] COMMAND [ARGS]...

Commands

cursor: Set the cursor value for an existing sensor.

list: List all sensors that correspond to a…

preview: Preview an existing sensor execution.

start: Start an existing sensor.

stop: Stop an existing sensor.

dagster project¶

Commands for bootstrapping new Dagster projects and code locations.

dagster project [OPTIONS] COMMAND [ARGS]...

Commands

from-example: Download one of the official Dagster examples to the current directory. This CLI enables you to quickly bootstrap your project with an officially maintained example.

list-examples: List the examples that available to bootstrap with.

scaffold: Create a folder structure with a single Dagster code location and other files such as pyproject.toml. This CLI enables you to quickly start building a new Dagster project with everything set up.

scaffold-code-location: (DEPRECATED; Use dagster project scaffold –excludes README.md instead) Create a folder structure with a single Dagster code location, in the current directory. This CLI helps you to scaffold a new Dagster code location within a folder structure that includes multiple Dagster code locations.

scaffold-repository: (DEPRECATED; Use dagster project scaffold –excludes README.md instead) Create a folder structure with a single Dagster repository, in the current directory. This CLI helps you to scaffold a new Dagster repository within a folder structure that includes multiple Dagster repositories

dagster-graphql¶

Run a GraphQL query against the dagster interface to a specified repository or pipeline/job.

Can only use ONE of –workspace/-w, –python-file/-f, –module-name/-m, –grpc-port, –grpc-socket.

Examples:

dagster-graphql
dagster-graphql -y path/to/workspace.yaml
dagster-graphql -f path/to/file.py -a define_repo
dagster-graphql -m some_module -a define_repo
dagster-graphql -f path/to/file.py -a define_pipeline
dagster-graphql -m some_module -a define_pipeline

dagster-graphql [OPTIONS]

Options

--version¶: Show the version and exit.

-t, --text <text>¶: GraphQL document to execute passed as a string

-f, --file <file>¶: GraphQL document to execute passed as a file

-p, --predefined <predefined>¶

GraphQL document to execute, from a predefined set provided by dagster-graphql.

Options:: launchPipelineExecution

-v, --variables <variables>¶: A JSON encoded string containing the variables for GraphQL execution.

-r, --remote <remote>¶: A URL for a remote instance running dagster-webserver to send the GraphQL request to.

-o, --output <output>¶: A file path to store the GraphQL response to. This flag is useful when making pipeline/job execution queries, since pipeline/job execution causes logs to print to stdout and stderr.

--ephemeral-instance¶: Use an ephemeral DagsterInstance instead of resolving via DAGSTER_HOME

--empty-workspace¶: Allow an empty workspace

-w, --workspace <workspace>¶: Path to workspace file. Argument can be provided multiple times.

-d, --working-directory <working_directory>¶: Specify working directory to use when loading the repository or job

-f, --python-file <python_file>¶: Specify python file or files (flag can be used multiple times) where dagster definitions reside as top-level symbols/variables and load each file as a code location in the current python environment.

-m, --module-name <module_name>¶: Specify module or modules (flag can be used multiple times) where dagster definitions reside as top-level symbols/variables and load each module as a code location in the current python environment.

--package-name <package_name>¶: Specify Python package where repository or job function lives

-a, --attribute <attribute>¶: Attribute that is either a 1) repository or job or 2) a function that returns a repository or job

--grpc-port <grpc_port>¶: Port to use to connect to gRPC server

--grpc-socket <grpc_socket>¶: Named socket to use to connect to gRPC server

--grpc-host <grpc_host>¶: Host to use to connect to gRPC server, defaults to localhost

--use-ssl¶: Use a secure channel when connecting to the gRPC server

Environment variables

DAGSTER_WORKING_DIRECTORY: Provide a default for --working-directory

DAGSTER_PYTHON_FILE: Provide a default for --python-file

DAGSTER_MODULE_NAME: Provide a default for --module-name

DAGSTER_PACKAGE_NAME: Provide a default for --package-name

DAGSTER_ATTRIBUTE: Provide a default for --attribute

dagster-webserver¶

Run dagster-webserver. Loads a code location.

Can only use ONE of –workspace/-w, –python-file/-f, –module-name/-m, –grpc-port, –grpc-socket.

Examples:

dagster-webserver (works if ./workspace.yaml exists)
dagster-webserver -w path/to/workspace.yaml
dagster-webserver -f path/to/file.py
dagster-webserver -f path/to/file.py -d path/to/working_directory
dagster-webserver -m some_module
dagster-webserver -f path/to/file.py -a define_repo
dagster-webserver -m some_module -a define_repo
dagster-webserver -p 3333

Options can also provide arguments via environment variables prefixed with DAGSTER_WEBSERVER.

For example, DAGSTER_WEBSERVER_PORT=3333 dagster-webserver

dagster-webserver [OPTIONS]

Options

--use-ssl¶: Use a secure channel when connecting to the gRPC server

--grpc-host <grpc_host>¶: Host to use to connect to gRPC server, defaults to localhost

--grpc-socket <grpc_socket>¶: Named socket to use to connect to gRPC server

--grpc-port <grpc_port>¶: Port to use to connect to gRPC server

-a, --attribute <attribute>¶: Attribute that is either a 1) repository or job or 2) a function that returns a repository or job

--package-name <package_name>¶: Specify Python package where repository or job function lives

-m, --module-name <module_name>¶: Specify module or modules (flag can be used multiple times) where dagster definitions reside as top-level symbols/variables and load each module as a code location in the current python environment.

-f, --python-file <python_file>¶: Specify python file or files (flag can be used multiple times) where dagster definitions reside as top-level symbols/variables and load each file as a code location in the current python environment.

-d, --working-directory <working_directory>¶: Specify working directory to use when loading the repository or job

-w, --workspace <workspace>¶: Path to workspace file. Argument can be provided multiple times.

--empty-workspace¶: Allow an empty workspace

-h, --host <host>¶

Host to run server on

Default:: '127.0.0.1'

-p, --port <port>¶: Port to run server on - defaults to 3000

-l, --path-prefix <path_prefix>¶

The path prefix where server will be hosted (eg: /dagster-webserver)

Default:: ''

--db-statement-timeout <db_statement_timeout>¶

The timeout in milliseconds to set on database statements sent to the DagsterInstance. Not respected in all configurations.

Default:: 15000

--db-pool-recycle <db_pool_recycle>¶

The maximum age of a connection to use from the sqlalchemy pool without connection recycling. Set to -1 to disable. Not respected in all configurations.

Default:: 3600

--read-only¶: Start server in read-only mode, where all mutations such as launching runs and turning schedules on/off are turned off.

--suppress-warnings¶: Filter all warnings when hosting server.

--uvicorn-log-level, --log-level <uvicorn_log_level>¶

Set the log level for the uvicorn web server.

Default:: 'warning'
Options:: critical | error | warning | info | debug | trace

--dagster-log-level <dagster_log_level>¶

Set the log level for dagster log events.

Default:: 'info'
Options:: critical | error | warning | info | debug

--log-format <log_format>¶

Format of the log output from the webserver

Default:: 'colored'
Options:: colored | json | rich

--code-server-log-level <code_server_log_level>¶

Set the log level for any code servers spun up by the webserver.

Default:: 'info'
Options:: critical | error | warning | info | debug

--live-data-poll-rate <live_data_poll_rate>¶

Rate at which the dagster UI polls for updated asset data (in milliseconds)

Default:: 2000

--version¶: Show the version and exit.

Environment variables

DAGSTER_ATTRIBUTE: Provide a default for --attribute

DAGSTER_PACKAGE_NAME: Provide a default for --package-name

DAGSTER_MODULE_NAME: Provide a default for --module-name

DAGSTER_PYTHON_FILE: Provide a default for --python-file

DAGSTER_WORKING_DIRECTORY: Provide a default for --working-directory

DAGSTER_WEBSERVER_LOG_LEVEL: Provide a default for --dagster-log-level

dagster-daemon run¶

Run any daemons configured on the DagsterInstance.

dagster-daemon run [OPTIONS]

Options

--code-server-log-level <code_server_log_level>¶

Set the log level for any code servers spun up by the daemon.

Default:: 'warning'
Options:: critical | error | warning | info | debug

--log-level <log_level>¶

Set the log level for any code servers spun up by the daemon.

Default:: 'info'
Options:: critical | error | warning | info | debug

--log-format <log_format>¶

Format of the log output from the webserver

Default:: 'colored'
Options:: colored | json | rich

--use-ssl¶: Use a secure channel when connecting to the gRPC server

--grpc-host <grpc_host>¶: Host to use to connect to gRPC server, defaults to localhost

--grpc-socket <grpc_socket>¶: Named socket to use to connect to gRPC server

--grpc-port <grpc_port>¶: Port to use to connect to gRPC server

-a, --attribute <attribute>¶: Attribute that is either a 1) repository or job or 2) a function that returns a repository or job

--package-name <package_name>¶: Specify Python package where repository or job function lives

-m, --module-name <module_name>¶: Specify module or modules (flag can be used multiple times) where dagster definitions reside as top-level symbols/variables and load each module as a code location in the current python environment.

-f, --python-file <python_file>¶: Specify python file or files (flag can be used multiple times) where dagster definitions reside as top-level symbols/variables and load each file as a code location in the current python environment.

-d, --working-directory <working_directory>¶: Specify working directory to use when loading the repository or job

-w, --workspace <workspace>¶: Path to workspace file. Argument can be provided multiple times.

--empty-workspace¶: Allow an empty workspace

Environment variables

DAGSTER_DAEMON_LOG_LEVEL: Provide a default for --log-level

DAGSTER_ATTRIBUTE: Provide a default for --attribute

DAGSTER_PACKAGE_NAME: Provide a default for --package-name

DAGSTER_MODULE_NAME: Provide a default for --module-name

DAGSTER_PYTHON_FILE: Provide a default for --python-file

DAGSTER_WORKING_DIRECTORY: Provide a default for --working-directory

dagster-daemon wipe¶

Wipe all heartbeats from storage.

dagster-daemon wipe [OPTIONS]

dagster-daemon debug heartbeat-dump¶

Log all heartbeat statuses

dagster-daemon debug heartbeat-dump [OPTIONS]

dagster api grpc¶

Serve the Dagster inter-process API over GRPC

dagster api grpc [OPTIONS]

Options

-p, --port <port>¶: Port over which to serve. You must pass one and only one of –port/-p or –socket/-s.

-s, --socket <socket>¶: Serve over a UDS socket. You must pass one and only one of –port/-p or –socket/-s.

-h, --host <host>¶: Hostname at which to serve. Default is localhost.

-n, --max-workers, --max_workers <max_workers>¶: Maximum number of (threaded) workers to use in the GRPC server

--heartbeat¶: If set, the GRPC server will shut itself down when it fails to receive a heartbeat after a timeout configurable with –heartbeat-timeout.

--heartbeat-timeout <heartbeat_timeout>¶: Timeout after which to shutdown if –heartbeat is set and a heartbeat is not received

--lazy-load-user-code¶: Wait until the first LoadRepositories call to actually load the repositories, instead of waiting to load them when the server is launched. Useful for surfacing errors when the server is managed directly from the Dagster UI.

-a, --attribute <attribute>¶: Attribute that is either a 1) repository or job or 2) a function that returns a repository or job

--package-name <package_name>¶: Specify Python package where repository or job function lives

-m, --module-name <module_name>¶: Specify module where dagster definitions reside as top-level symbols/variables and load the module as a code location in the current python environment.

-f, --python-file <python_file>¶: Specify python file where dagster definitions reside as top-level symbols/variables and load the file as a code location in the current python environment.

-d, --working-directory <working_directory>¶: Specify working directory to use when loading the repository or job

--use-python-environment-entry-point¶: If this flag is set, the server will signal to clients that they should launch dagster commands using <this server’s python executable> -m dagster, instead of the default dagster entry point. This is useful when there are multiple Python environments running in the same machine, so a single dagster entry point is not enough to uniquely determine the environment.

--empty-working-directory¶: Indicates that the working directory should be empty and should not set to the current directory as a default

--fixed-server-id <fixed_server_id>¶: [INTERNAL] This option should generally not be used by users. Internal param used by dagster to spawn a gRPC server with the specified server id.

--log-level <log_level>¶

Level at which to log output from the code server process

Default:: 'info'
Options:: critical | error | warning | info | debug

--log-format <log_format>¶

Format of the log output from the code server process

Default:: 'colored'
Options:: colored | json | rich

--container-image <container_image>¶: Container image to use to run code from this server.

--container-context <container_context>¶: Serialized JSON with configuration for any containers created to run the code from this server.

--inject-env-vars-from-instance¶: Whether to load env vars from the instance and inject them into the environment.

--location-name <location_name>¶: Name of the code location this server corresponds to.

--instance-ref <instance_ref>¶: [INTERNAL] Serialized InstanceRef to use for accessing the instance

--enable-metrics¶: [INTERNAL] Retrieves current utilization metrics from GRPC server.

Environment variables

DAGSTER_GRPC_PORT: Provide a default for --port

DAGSTER_GRPC_SOCKET: Provide a default for --socket

DAGSTER_GRPC_HOST: Provide a default for --host

DAGSTER_GRPC_MAX_WORKERS: Provide a default for --max-workers

DAGSTER_LAZY_LOAD_USER_CODE: Provide a default for --lazy-load-user-code

DAGSTER_ATTRIBUTE: Provide a default for --attribute

DAGSTER_PACKAGE_NAME: Provide a default for --package-name

DAGSTER_MODULE_NAME: Provide a default for --module-name

DAGSTER_PYTHON_FILE: Provide a default for --python-file

DAGSTER_WORKING_DIRECTORY: Provide a default for --working-directory

DAGSTER_USE_PYTHON_ENVIRONMENT_ENTRY_POINT: Provide a default for --use-python-environment-entry-point

DAGSTER_EMPTY_WORKING_DIRECTORY: Provide a default for --empty-working-directory

DAGSTER_CONTAINER_IMAGE: Provide a default for --container-image

DAGSTER_CONTAINER_CONTEXT: Provide a default for --container-context

DAGSTER_INJECT_ENV_VARS_FROM_INSTANCE: Provide a default for --inject-env-vars-from-instance

DAGSTER_LOCATION_NAME: Provide a default for --location-name

DAGSTER_INSTANCE_REF: Provide a default for --instance-ref

DAGSTER_ENABLE_SERVER_METRICS: Provide a default for --enable-metrics

You are viewing an unreleased or outdated version of the documentation

Dagster CLI¶

dagster asset¶

dagster debug¶

dagster definitions validate¶

dagster dev¶

dagster instance¶

dagster job¶

dagster run¶

dagster schedule¶

dagster sensor¶

dagster project¶

dagster-graphql¶

dagster-webserver¶

dagster-daemon run¶

dagster-daemon wipe¶

dagster-daemon debug heartbeat-dump¶

dagster api grpc¶