CLI Commands Reference

If you are looking for extensive information on a specific CLI command, this part of the documentation is for you.

dp

dp [OPTIONS] COMMAND [ARGS]...

Options

--version: Show the version and exit.

clean

Delete local working directories

dp clean [OPTIONS]

compile

Create local working directories and build artifacts

dp compile [OPTIONS]

Options

--env <env>

Required Name of the environment

Default: base

--docker-build: Whether to build a Docker image

create

Create a new project using a template

dp create [OPTIONS] PROJECT_PATH [TEMPLATE_PATH]...

Arguments

PROJECT_PATH: Required argument

TEMPLATE_PATH: Optional argument(s)

deploy

Push and deploy the project to the remote machine

dp deploy [OPTIONS]

Options

--env <env>

Name of the environment

Default: base

--dags-path <dags_path>: Remote storage URI

--blob-args <blob_args>: Path to JSON or YAML file with arguments that should be passed to your Bucket/blob provider

--docker-push: Whether to push image to the Docker repository

--datahub-ingest: Whether to ingest DataHub metadata

init

Configure the tool for the first time

dp init [OPTIONS] [CONFIG_PATH]...

Arguments

CONFIG_PATH: Optional argument(s)

prepare-env

Prepare local environment for apps interfacing with dbt

dp prepare-env [OPTIONS]

Options

--env <env>: Name of the environment

publish

Create a dbt package out of the project

dp publish [OPTIONS]

run

Run the project on the local machine

dp run [OPTIONS]

Options

--env <env>

Name of the environment

Default: local

template-list

Print a list of all templates saved in the config file

dp template-list [OPTIONS]

test

Run tests of the project on the local machine

dp test [OPTIONS]

Options

--env <env>

Name of the environment

Default: local

update

Update project from its template

dp update [OPTIONS] [PROJECT_PATH]...

Options

--vcs-ref <vcs_ref>: Git reference to checkout

Arguments

PROJECT_PATH: Optional argument(s)