99207237fe
* bumps to version 1.20.0 * update the hub reference docs, add CI check * use dependency specifier in hub for plugin version check * minimum dlt runtime cli check * rollaback to old fsspec min version * fixes test_hub ci workflow * fixes flaky test * bumps hub extra * updates cli docs linting * fixes docs lock --------- Co-authored-by: Marcin Rudolf <rudolfix@rudolfix.org> Co-authored-by: ivasio <ivan@dlthub.com>
32 KiB
title, description, keywords
| title | description | keywords | |||
|---|---|---|---|---|---|
| Command Line Interface | Command line interface (CLI) full reference of dlt |
|
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,license,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
dlt workspace
Manage current Workspace.
Usage
dlt workspace [-h] [--verbose] {clean,info,mcp,show} ...
Description
Commands to get info, cleanup local files and launch Workspace MCP. Run without command get workspace info.
Show Arguments and Options
Inherits arguments from dlt.
Options
-h, --help- Show this help message and exit--verbose, -v- Provides more information for certain commands.
Available subcommands
clean- Cleans local data for the selected profile. locally loaded data will be deleted. pipelines working directories are also deleted by default. data in remote destinations is not affected.info- Displays workspace info.mcp- Launch dlt mcp server in current python environment and workspace in sse transport mode by default.show- Shows workspace dashboard for the pipelines and data in this workspace.
dlt workspace clean
Cleans local data for the selected profile. Locally loaded data will be deleted. Pipelines working directories are also deleted by default. Data in remote destinations is not affected.
Usage
dlt workspace clean [-h] [--skip-data-dir]
Description
Cleans local data for the selected profile. Locally loaded data will be deleted. Pipelines working directories are also deleted by default. Data in remote destinations is not affected.
Show Arguments and Options
Inherits arguments from dlt workspace.
Options
-h, --help- Show this help message and exit--skip-data-dir- Do not delete pipelines working dir.
dlt workspace info
Displays workspace info.
Usage
dlt workspace info [-h]
Description
Displays workspace info.
Show Arguments and Options
Inherits arguments from dlt workspace.
Options
-h, --help- Show this help message and exit
dlt workspace mcp
Launch dlt MCP server in current Python environment and Workspace in SSE transport mode by default.
Usage
dlt workspace mcp [-h] [--stdio] [--port PORT]
Description
This MCP allows to attach to any pipeline that was previously ran in this workspace and then facilitates schema and data exploration in the pipeline's dataset.
Show Arguments and Options
Inherits arguments from dlt workspace.
Options
-h, --help- Show this help message and exit--stdio- Use stdio transport mode--port PORT- Sse port to use (default: 43654)
dlt workspace show
Shows Workspace Dashboard for the pipelines and data in this workspace.
Usage
dlt workspace show [-h] [--edit]
Description
Shows Workspace Dashboard for the pipelines and data in this workspace.
Show Arguments and Options
Inherits arguments from dlt workspace.
Options
-h, --help- Show this help message and exit--edit- Eject dashboard and start editable version
dlt profile
Manage Workspace built-in profiles.
Usage
dlt profile [-h] [profile_name] {info,list,pin} ...
Description
Commands to list and pin profiles Run without arguments to list all profiles, the default profile and the pinned profile in current project.
Show Arguments and Options
Inherits arguments from dlt.
Positional arguments
profile_name- Name of the profile
Options
-h, --help- Show this help message and exit
Available subcommands
dlt profile info
Show information about the current profile.
Usage
dlt profile [profile_name] info [-h]
Description
Show information about the current profile.
Show Arguments and Options
Inherits arguments from dlt profile.
Options
-h, --help- Show this help message and exit
dlt profile list
Show list of built-in profiles.
Usage
dlt profile [profile_name] list [-h]
Description
Show list of built-in profiles.
Show Arguments and Options
Inherits arguments from dlt profile.
Options
-h, --help- Show this help message and exit
dlt profile pin
Pin a profile to the Workspace.
Usage
dlt profile [profile_name] pin [-h]
Description
Pin a profile to the Workspace, this will be the new default profile while it is pinned.
Show Arguments and Options
Inherits arguments from dlt profile.
Options
-h, --help- Show this help message and exit
dlt license
View dlthub license status.
Usage
dlt license [-h] {info,scopes,issue} ...
Description
View dlthub license status.
Show Arguments and Options
Inherits arguments from dlt.
Options
-h, --help- Show this help message and exit
Available subcommands
dlt license info
Show the installed license.
Usage
dlt license info [-h]
Description
Show the installed license.
Show Arguments and Options
Inherits arguments from dlt license.
Options
-h, --help- Show this help message and exit
dlt license scopes
Show available scopes.
Usage
dlt license scopes [-h]
Description
Show available scopes.
Show Arguments and Options
Inherits arguments from dlt license.
Options
-h, --help- Show this help message and exit
dlt license issue
Issues a self-signed trial license that may be used for development, testing and for ci ops.
Usage
dlt license issue [-h] scope
Description
Issue a new self-signed trial license.
Show Arguments and Options
Inherits arguments from dlt license.
Positional arguments
scope- Scope of the license, a comma separated list of the scopes: ['dlthub.dbt_generator', 'dlthub.sources.mssql', 'dlthub.project', 'dlthub.transformation', 'dlthub.data_quality', 'dlthub.destinations.iceberg', 'dlthub.destinations.snowflake_plus', 'dlthub.runner']
Options
-h, --help- Show this help message and exit
dlt runtime
Connect to dltHub Runtime and run your code remotely.
Usage
dlt runtime [-h]
{login,logout,launch,serve,publish,schedule,logs,cancel,dashboard,deploy,info,deployment,job,jobs,job-run,job-runs,configuration}
...
Description
Allows 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
Available subcommands
login- Login to dlthub runtime using github oauth and connect current workspace to the remote onelogout- Logout from dlthub runtimelaunch- Deploy code/config and run a script (follow status and logs by default)serve- Deploy and serve an interactive notebook/app (read-only) and follow until readypublish- Generate or revoke a public link for an interactive notebook/appschedule- Deploy and schedule a script with a cron timetable, or cancel the scheduled script from future runslogs- Show logs for latest or selected job runcancel- Cancel latest or selected job rundashboard- Open the runtime dashboard for this workspacedeploy- Sync code and configuration to runtime without running anythinginfo- Show overview of current runtime workspacedeployment- Manipulate deployments in workspacejob- List, create and inspect jobsjobs- List, create and inspect jobsjob-run- List, create and inspect job runsjob-runs- List, create and inspect job runsconfiguration- Manipulate configurations in workspace
dlt runtime login
Login to dltHub Runtime using Github OAuth and connect current workspace to the remote one.
Usage
dlt runtime login [-h]
Description
Login to dltHub Runtime using Github OAuth.
Show Arguments and Options
Inherits arguments from dlt runtime.
Options
-h, --help- Show this help message and exit
dlt runtime logout
Logout from dltHub Runtime.
Usage
dlt runtime logout [-h]
Description
Logout 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 (follow status and logs by default).
Usage
dlt runtime launch [-h] [-d] script_path
Description
Deploy current workspace and run a batch script remotely.
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-d, --detach- Do not follow status changes and logs after starting
dlt runtime serve
Deploy and serve an interactive notebook/app (read-only) and follow until ready.
Usage
dlt runtime serve [-h] 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
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 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 scriptcron_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 logs
Show logs for latest or selected job run.
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.
Show Arguments and Options
Inherits arguments from dlt runtime.
Positional arguments
script_path_or_job_name- Local path or job namerun_number- Run number (optional)
Options
-h, --help- Show this help message and exit-f, --follow- Follow the logs of the run in tailing mode
dlt runtime cancel
Cancel latest or selected job run.
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 namerun_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.
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.
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 workspace.
Usage
dlt runtime deployment [-h] [deployment_version_no] {list,info,sync} ...
Description
Manipulate deployments in workspace.
Show Arguments and Options
Inherits arguments from dlt runtime.
Positional arguments
deployment_version_no- Deployment version number. only used in theinfosubcommand
Options
-h, --help- Show this help message and exit
Available subcommands
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 exceptlist
Options
-h, --help- Show this help message and exit
Available subcommands
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] [--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--description [DESCRIPTION]- Job description
dlt runtime jobs
List, create and inspect jobs.
Usage
dlt runtime jobs [-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 exceptlist
Options
-h, --help- Show this help message and exit
Available subcommands
dlt runtime jobs list
List the jobs registered in the workspace.
Usage
dlt runtime jobs [script_path_or_job_name] list [-h]
Description
List the jobs registered in the workspace.
Show Arguments and Options
Inherits arguments from dlt runtime jobs.
Options
-h, --help- Show this help message and exit
dlt runtime jobs info
Show job info.
Usage
dlt runtime jobs [script_path_or_job_name] info [-h]
Description
Display detailed information about the job.
Show Arguments and Options
Inherits arguments from dlt runtime jobs.
Options
-h, --help- Show this help message and exit
dlt runtime jobs create
Create a job without running it.
Usage
dlt runtime jobs [script_path_or_job_name] create [-h] [--name [NAME]]
[--schedule [SCHEDULE]] [--interactive] [--description [DESCRIPTION]]
Description
Manually create the job.
Show Arguments and Options
Inherits arguments from dlt runtime jobs.
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--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 exceptlistrun_number- Run number. used in all commands exceptlistandcreateas optional argument. if not specified, the latest run of given script be used.
Options
-h, --help- Show this help message and exit
Available subcommands
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 --follow to follow the logs in tailing mode.
Show Arguments and Options
Inherits arguments from dlt runtime job-run.
Options
-h, --help- Show this help message and exit-f, --follow- Follow the logs of the run in tailing mode
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 job-runs
List, create and inspect job runs.
Usage
dlt runtime job-runs [-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 exceptlistrun_number- Run number. used in all commands exceptlistandcreateas optional argument. if not specified, the latest run of given script be used.
Options
-h, --help- Show this help message and exit
Available subcommands
dlt runtime job-runs list
List the job runs registered in the workspace.
Usage
dlt runtime job-runs [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-runs.
Options
-h, --help- Show this help message and exit
dlt runtime job-runs info
Show job run info.
Usage
dlt runtime job-runs [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-runs.
Options
-h, --help- Show this help message and exit
dlt runtime job-runs create
Create a job run without running it.
Usage
dlt runtime job-runs [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-runs.
Options
-h, --help- Show this help message and exit
dlt runtime job-runs logs
Show logs for the latest or selected job run.
Usage
dlt runtime job-runs [script_path_or_job_name] [run_number] logs [-h] [-f]
Description
Show logs for the latest or selected job run. Use --follow to follow the logs in tailing mode.
Show Arguments and Options
Inherits arguments from dlt runtime job-runs.
Options
-h, --help- Show this help message and exit-f, --follow- Follow the logs of the run in tailing mode
dlt runtime job-runs cancel
Cancel the latest or selected job run.
Usage
dlt runtime job-runs [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-runs.
Options
-h, --help- Show this help message and exit
dlt runtime configuration
Manipulate configurations in workspace.
Usage
dlt runtime configuration [-h] [configuration_version_no] {list,info,sync} ...
Description
Manipulate configurations in workspace.
Show Arguments and Options
Inherits arguments from dlt runtime.
Positional arguments
configuration_version_no- Configuration version number. only used in theinfosubcommand
Options
-h, --help- Show this help message and exit
Available subcommands
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