Skip to main content

Command Line Interface Reference

This page contains all commands available in the dlt CLI and is generated automatically from the fully populated python argparse object of dlt.

note

Flags and positional commands are inherited from the parent command. Position within the command string is important. For example if you want to enable debug mode on the pipeline command, you need to add the debug flag to the base dlt command:

dlt --debug pipeline

Adding the flag after the pipeline keyword will not work.

dlt​

Creates, adds, inspects and deploys dlt pipelines. Further help is available at https://dlthub.com/docs/reference/command-line-interface.

Usage

dlt [-h] [--version] [--disable-telemetry] [--enable-telemetry]
    [--non-interactive] [--debug] [--no-pwd]
    {workspace,telemetry,schema,profile,pipeline,init,render-docs,deploy,dashboard,ai,runtime}
    ...
Show Arguments and Options

Options

  • -h, --help - Show this help message and exit
  • --version - Show program's version number and exit
  • --disable-telemetry - Disables telemetry before command is executed
  • --enable-telemetry - Enables telemetry before command is executed
  • --non-interactive - Non interactive mode. default choices are automatically made for confirmations and prompts.
  • --debug - Displays full stack traces on exceptions. useful for debugging if the output is not clear enough.
  • --no-pwd - Do not add current working directory to sys.path. by default $pwd is added to reproduce python behavior when running scripts.

Available subcommands

  • runtime - Connect to dlthub runtime and run your code remotely

dlt runtime​

Connect to dltHub Runtime and run your code remotely.

Usage

dlt runtime [-h] [--help-all]
    {login,logout,launch,serve,publish,unpublish,schedule,unschedule,logs,cancel,dashboard,deploy,info,deployment,job,jobs,job-run,job-runs,configuration,workspace}
    ...

Description

Allows you to connect to the dltHub Runtime, deploy and run local workspaces there. Requires dltHub license.

Show Arguments and Options

Inherits arguments from dlt.

Options

  • -h, --help - Show this help message and exit
  • --help-all - Show all commands including subcommands

Available subcommands

  • login - Log in to dlthub runtime and connect the current workspace to the remote one
  • logout - Log out from dlthub runtime
  • launch - Deploy code/config and run a script
  • serve - Deploy and serve an interactive notebook/app (read-only) and follow until ready
  • publish - Generate or revoke a public link for an interactive notebook/app
  • unpublish - Revoke the public link for an interactive notebook/app
  • schedule - Deploy and schedule a script with a cron timetable, or cancel the scheduled script from future runs
  • unschedule - Remove the cron schedule from a script
  • logs - Show logs for latest or selected job run (shortcut for 'job-run logs')
  • cancel - Cancel latest or selected job run (shortcut for 'job-run cancel')
  • dashboard - Open the runtime dashboard for this workspace
  • deploy - Sync code and configuration to runtime without running anything (shortcut for 'deployment sync' + 'configuration sync')
  • info - Show overview of current runtime workspace (shows workspace, job count, latest run, latest deployment, and latest configuration)
  • deployment - Manipulate deployments in the workspace
  • job - List, create and inspect jobs
  • job-run - List, create and inspect job runs
  • configuration - Manipulate configurations in the workspace
  • workspace - List and manage workspaces

dlt runtime login​

Log in to dltHub Runtime and connect the current workspace to the remote one.

Usage

dlt runtime login [-h] [--workspace WORKSPACE]

Description

Log in to dltHub Runtime.

Show Arguments and Options

Inherits arguments from dlt runtime.

Options

  • -h, --help - Show this help message and exit
  • --workspace, -w WORKSPACE - Select workspace by name or id (skip interactive prompt)

dlt runtime logout​

Log out from dltHub Runtime.

Usage

dlt runtime logout [-h]

Description

Log out from dltHub Runtime.

Show Arguments and Options

Inherits arguments from dlt runtime.

Options

  • -h, --help - Show this help message and exit

dlt runtime launch​

Deploy code/config and run a script.

Usage

dlt runtime launch [-h] [-f] script_path

Description

Deploy current workspace and run a batch script remotely. Use -f/--follow to tail logs until completion.

Show Arguments and Options

Inherits arguments from dlt runtime.

Positional arguments

  • script_path - Local path to the script

Options

  • -h, --help - Show this help message and exit
  • -f, --follow - Follow status changes and stream logs until the run completes

dlt runtime serve​

Deploy and serve an interactive notebook/app (read-only) and follow until ready.

Usage

dlt runtime serve [-h] [--app-type {marimo,mcp,streamlit}] script_path

Description

Deploy current workspace and run a notebook as a read-only web app.

Show Arguments and Options

Inherits arguments from dlt runtime.

Positional arguments

  • script_path - Local path to the notebook/app

Options

  • -h, --help - Show this help message and exit
  • --app-type {marimo,mcp,streamlit} - Specify if the interactive job is a marimo notebook, streamlit app, or mcp server

dlt runtime publish​

Generate or revoke a public link for an interactive notebook/app.

Usage

dlt runtime publish [-h] [--cancel] script_path

Description

Generate a public link for a notebook/app, or revoke it with --cancel.

Show Arguments and Options

Inherits arguments from dlt runtime.

Positional arguments

  • script_path - Local path to the notebook/app

Options

  • -h, --help - Show this help message and exit
  • --cancel - Revoke the public link for the notebook/app

dlt runtime unpublish​

Revoke the public link for an interactive notebook/app.

Usage

dlt runtime unpublish [-h] script_path

Description

Revoke the public link for an interactive notebook/app.

Show Arguments and Options

Inherits arguments from dlt runtime.

Positional arguments

  • script_path - Local path to the notebook/app

Options

  • -h, --help - Show this help message and exit

dlt runtime schedule​

Deploy and schedule a script with a cron timetable, or cancel the scheduled script from future runs.

Usage

dlt runtime schedule [-h] [--current] script_path cron_expr_or_cancel

Description

Schedule a batch script to run on a cron timetable, or cancel the scheduled script from future runs.

Show Arguments and Options

Inherits arguments from dlt runtime.

Positional arguments

  • script_path - Local path to the script
  • cron_expr_or_cancel - Either a cron schedule string if you want to schedule the script, or the literal 'cancel' command if you want to cancel it

Options

  • -h, --help - Show this help message and exit
  • --current - When cancelling the schedule, also cancel the currently running instance if any

dlt runtime unschedule​

Remove the cron schedule from a script.

Usage

dlt runtime unschedule [-h] [--current] script_path

Description

Remove the cron schedule from a script, stopping future scheduled runs.

Show Arguments and Options

Inherits arguments from dlt runtime.

Positional arguments

  • script_path - Local path to the script

Options

  • -h, --help - Show this help message and exit
  • --current - Also cancel the currently running instance if any

dlt runtime logs​

Show logs for latest or selected job run (shortcut for 'job-run logs').

Usage

dlt runtime logs [-h] [-f] script_path_or_job_name [run_number]

Description

Show logs for the latest run of a job or a specific run number. Use -f/--follow to stream logs in real-time.

Show Arguments and Options

Inherits arguments from dlt runtime.

Positional arguments

  • script_path_or_job_name - Local path or job name
  • run_number - Run number (optional)

Options

  • -h, --help - Show this help message and exit
  • -f, --follow - Follow logs in real-time until the run completes

dlt runtime cancel​

Cancel latest or selected job run (shortcut for 'job-run cancel').

Usage

dlt runtime cancel [-h] script_path_or_job_name [run_number]

Description

Cancel the latest run of a job or a specific run number.

Show Arguments and Options

Inherits arguments from dlt runtime.

Positional arguments

  • script_path_or_job_name - Local path or job name
  • run_number - Run number (optional)

Options

  • -h, --help - Show this help message and exit

dlt runtime dashboard​

Open the Runtime dashboard for this workspace.

Usage

dlt runtime dashboard [-h]

Description

Open link to the Runtime dashboard for current remote workspace.

Show Arguments and Options

Inherits arguments from dlt runtime.

Options

  • -h, --help - Show this help message and exit

dlt runtime deploy​

Sync code and configuration to Runtime without running anything (shortcut for 'deployment sync' + 'configuration sync').

Usage

dlt runtime deploy [-h]

Description

Upload deployment and configuration if changed.

Show Arguments and Options

Inherits arguments from dlt runtime.

Options

  • -h, --help - Show this help message and exit

dlt runtime info​

Show overview of current Runtime workspace (shows workspace, job count, latest run, latest deployment, and latest configuration).

Usage

dlt runtime info [-h]

Description

Show workspace ID and summary of deployments, configurations and jobs.

Show Arguments and Options

Inherits arguments from dlt runtime.

Options

  • -h, --help - Show this help message and exit

dlt runtime deployment​

Manipulate deployments in the workspace.

Usage

dlt runtime deployment [-h] [deployment_version_no] {list,info,sync} ...

Description

Manipulate deployments in the workspace.

Show Arguments and Options

Inherits arguments from dlt runtime.

Positional arguments

  • deployment_version_no - Deployment version number. only used in the info subcommand

Options

  • -h, --help - Show this help message and exit

Available subcommands

  • list - List all deployments in workspace
  • info - Get detailed information about a deployment
  • sync - Create new deployment if local workspace content changed

dlt runtime deployment list​

List all deployments in workspace.

Usage

dlt runtime deployment [deployment_version_no] list [-h]

Description

List all deployments in workspace.

Show Arguments and Options

Inherits arguments from dlt runtime deployment.

Options

  • -h, --help - Show this help message and exit

dlt runtime deployment info​

Get detailed information about a deployment.

Usage

dlt runtime deployment [deployment_version_no] info [-h]

Description

Get detailed information about a deployment.

Show Arguments and Options

Inherits arguments from dlt runtime deployment.

Options

  • -h, --help - Show this help message and exit

dlt runtime deployment sync​

Create new deployment if local workspace content changed.

Usage

dlt runtime deployment [deployment_version_no] sync [-h]

Description

Create new deployment if local workspace content changed.

Show Arguments and Options

Inherits arguments from dlt runtime deployment.

Options

  • -h, --help - Show this help message and exit

dlt runtime job​

List, create and inspect jobs.

Usage

dlt runtime job [-h] [script_path_or_job_name] {list,info,create} ...

Description

List and manipulate jobs registered in the workspace.

Show Arguments and Options

Inherits arguments from dlt runtime.

Positional arguments

  • script_path_or_job_name - Local script path or job name. required for all commands except list

Options

  • -h, --help - Show this help message and exit

Available subcommands

  • list - List the jobs registered in the workspace
  • info - Show job info
  • create - Create a job without running it

dlt runtime job list​

List the jobs registered in the workspace.

Usage

dlt runtime job [script_path_or_job_name] list [-h]

Description

List the jobs registered in the workspace.

Show Arguments and Options

Inherits arguments from dlt runtime job.

Options

  • -h, --help - Show this help message and exit

dlt runtime job info​

Show job info.

Usage

dlt runtime job [script_path_or_job_name] info [-h]

Description

Display detailed information about the job.

Show Arguments and Options

Inherits arguments from dlt runtime job.

Options

  • -h, --help - Show this help message and exit

dlt runtime job create​

Create a job without running it.

Usage

dlt runtime job [script_path_or_job_name] create [-h] [--name [NAME]]
    [--schedule [SCHEDULE]] [--interactive] [--app-type {marimo,mcp,streamlit}]
    [--description [DESCRIPTION]]

Description

Manually create the job.

Show Arguments and Options

Inherits arguments from dlt runtime job.

Options

  • -h, --help - Show this help message and exit
  • --name [NAME] - Job name to create
  • --schedule [SCHEDULE] - Cron schedule for the job if it's a scheduled one
  • --interactive - Run the job interactively, e.g. for a notebook
  • --app-type {marimo,mcp,streamlit} - Specify if the interactive app is a marimo notebook, streamlit app, or mcp server.
  • --description [DESCRIPTION] - Job description

dlt runtime job-run​

List, create and inspect job runs.

Usage

dlt runtime job-run [-h] [script_path_or_job_name] [run_number]
    {list,info,create,logs,cancel} ...

Description

List and manipulate job runs registered in the workspace.

Show Arguments and Options

Inherits arguments from dlt runtime.

Positional arguments

  • script_path_or_job_name - Local script path or job name. required for all commands except list
  • run_number - Run number. used in all commands except list and create as optional argument. if not specified, the latest run of the given script will be used.

Options

  • -h, --help - Show this help message and exit

Available subcommands

  • list - List the job runs registered in the workspace
  • info - Show job run info
  • create - Create a job run without running it
  • logs - Show logs for the latest or selected job run
  • cancel - Cancel the latest or selected job run

dlt runtime job-run list​

List the job runs registered in the workspace.

Usage

dlt runtime job-run [script_path_or_job_name] [run_number] list [-h]

Description

List the job runs registered in the workspace.

Show Arguments and Options

Inherits arguments from dlt runtime job-run.

Options

  • -h, --help - Show this help message and exit

dlt runtime job-run info​

Show job run info.

Usage

dlt runtime job-run [script_path_or_job_name] [run_number] info [-h]

Description

Display detailed information about the job run.

Show Arguments and Options

Inherits arguments from dlt runtime job-run.

Options

  • -h, --help - Show this help message and exit

dlt runtime job-run create​

Create a job run without running it.

Usage

dlt runtime job-run [script_path_or_job_name] [run_number] create [-h]

Description

Manually create the job run.

Show Arguments and Options

Inherits arguments from dlt runtime job-run.

Options

  • -h, --help - Show this help message and exit

dlt runtime job-run logs​

Show logs for the latest or selected job run.

Usage

dlt runtime job-run [script_path_or_job_name] [run_number] logs [-h] [-f]

Description

Show logs for the latest or selected job run. Use -f/--follow to stream logs in real-time until completion.

Show Arguments and Options

Inherits arguments from dlt runtime job-run.

Options

  • -h, --help - Show this help message and exit
  • -f, --follow - Follow logs in real-time until the run completes

dlt runtime job-run cancel​

Cancel the latest or selected job run.

Usage

dlt runtime job-run [script_path_or_job_name] [run_number] cancel [-h]

Description

Cancel the latest or selected job run.

Show Arguments and Options

Inherits arguments from dlt runtime job-run.

Options

  • -h, --help - Show this help message and exit

dlt runtime configuration​

Manipulate configurations in the workspace.

Usage

dlt runtime configuration [-h] [configuration_version_no] {list,info,sync} ...

Description

Manipulate configurations in the workspace.

Show Arguments and Options

Inherits arguments from dlt runtime.

Positional arguments

  • configuration_version_no - Configuration version number. only used in the info subcommand

Options

  • -h, --help - Show this help message and exit

Available subcommands

  • list - List all configuration versions
  • info - Get detailed information about a configuration
  • sync - Create new configuration if local config content changed

dlt runtime configuration list​

List all configuration versions.

Usage

dlt runtime configuration [configuration_version_no] list [-h]

Description

List all configuration versions.

Show Arguments and Options

Inherits arguments from dlt runtime configuration.

Options

  • -h, --help - Show this help message and exit

dlt runtime configuration info​

Get detailed information about a configuration.

Usage

dlt runtime configuration [configuration_version_no] info [-h]

Description

Get detailed information about a configuration.

Show Arguments and Options

Inherits arguments from dlt runtime configuration.

Options

  • -h, --help - Show this help message and exit

dlt runtime configuration sync​

Create new configuration if local config content changed.

Usage

dlt runtime configuration [configuration_version_no] sync [-h]

Description

Create new configuration if local config content changed.

Show Arguments and Options

Inherits arguments from dlt runtime configuration.

Options

  • -h, --help - Show this help message and exit

dlt runtime workspace​

List and manage workspaces.

Usage

dlt runtime workspace [-h] {list,switch} ...

Description

List and manage workspaces in your organization.

Show Arguments and Options

Inherits arguments from dlt runtime.

Options

  • -h, --help - Show this help message and exit

Available subcommands

  • list - List all workspaces you have access to
  • switch - Switch to a different workspace by name or id

dlt runtime workspace list​

List all workspaces you have access to.

Usage

dlt runtime workspace list [-h]

Description

List all workspaces you have access to.

Show Arguments and Options

Inherits arguments from dlt runtime workspace.

Options

  • -h, --help - Show this help message and exit

dlt runtime workspace switch​

Switch to a different workspace by name or ID.

Usage

dlt runtime workspace switch [-h] workspace

Description

Switch the locally connected workspace without re-running login.

Show Arguments and Options

Inherits arguments from dlt runtime workspace.

Positional arguments

  • workspace - Workspace name or id to switch to

Options

  • -h, --help - Show this help message and exit