Command Line Interface

PyDolphinScheduler have mechanism call CLI(command line interface) to help user control it in Shell.

Prepare

You have to install PyDolphinScheduler first before you using its CLI

Usage

Here is basic usage about the command line of PyDolphinScheduler

pydolphinscheduler

Apache DolphinScheduler Python API’s command line interface.

pydolphinscheduler [OPTIONS] COMMAND [ARGS]...

config

Manage the configuration for pydolphinscheduler.

pydolphinscheduler config [OPTIONS]

Options

-i, --init

Initialize and create configuration file to PYDS_HOME.

-s, --set <setter>

Set specific setting to config file.Use multiple --set <KEY> <VAL> options to set multiple configs

-g, --get <getter>

Get specific setting from config file.Use multiple --get <KEY> options to get multiple configs

version

Show current version of pydolphinscheduler.

pydolphinscheduler version [OPTIONS]

Options

-p, --part <part>

The part of version your want to get.

Options:

major | minor | micro

yaml

Create workflow using YAML file.

pydolphinscheduler yaml [OPTIONS]

Options

-f, --yaml_file <yaml_file>

Required YAML file path