GuidesAPI ReferenceDiscussions

Run a Task via CLI

How to run a task in DBND's CLI.

To run any command in DBND, use the following command pattern:

To list the available DBND commands, run dbnd --help.
To display arguments for any DBND command, use the --help argument.

Orchestration CLI Reference




Run a task or a pipeline


Initialize the project structure


Show and search configurations.


Show and search for tasks.


Get iPython shell with Databand's context

dbnd run Command Usage

dbnd_run Command Options




-s, --set

Sets a configuration value

--set task_name.task_parameter=value


Sets a configuration value (key=value)

-r, --set-root

Sets a main task parameter value without specifying task name. Allows to override specific parameters.

dbnd run predict_wine_quality --set-root alpha=5

In this example, alpha is overridden.

-o, --override

Overrides a configuration value (key=value). Has higher priority than any config source.


Defines a list of files to read from.

-m, --module

Loads modules dynamically. Allows to add a path of a module where DBND can search for tasks/pipelines.

dbnd run dbnd_sanity_check --module /path/to/

-v, --verbose

Makes the logging output more verbose.


Describes the current run.


Task environment:
local/aws/aws_prod/gcp/prod [default: local]


Runs specific tasks in parallel.


Sets a task version; it directly affects the task signature.


Name of this Databand project.


Sets description of the run.

dbnd run dbnd_sanity_check --description some_description


Sets name of the task.

dbnd run dbnd_sanity_check --task-name my_name


Use predefined uid for run.

dbnd run dbnd_sanity_check --override-run-uid 00000000-0000-0000-0000-000000000000


Is used for dynamic loading of modules

Running only specific tasks (according to regex):

You can use --set run.selected_tasks_regex=task_name_regex
You can also give it a list of regular expressions, and it will run all the tasks which conforms with those regular expressions: --set run.selected_tasks_regex="['regex1', 'regex2', ..]"
Note: running tasks like this will also run all of the tasks your diluted run depends on

Did this page help you?