Command line interface reference
This page contains all commands available in the dltHub CLI and is generated automatically from the fully populated python argparse object of dlt.
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]
{pipeline,workspace,telemetry,schema,profile,init,render-docs,deploy,dashboard,ai,transformation,source,project,license,destination,dbt,dataset,cache}
...
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] {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
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
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
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
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
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
dlt license
View dlthub license status.
Usage
dlt license [-h] {info,scopes,issue} ...
Description
View dlthub license status.
Show Arguments and Options
dlt license info
Show the installed license.
Usage
dlt license info [-h]
Description
Show the installed license.
Show Arguments and Options
dlt license scopes
Show available scopes.
Usage
dlt license scopes [-h]
Description
Show available scopes.
Show Arguments and Options
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.destinations.iceberg', 'dlthub.destinations.snowflake_plus', 'dlthub.runner']
Options
-h, --help- Show this help message and exit