DataCenterCDC-DS/dolphinscheduler-python/pydolphinscheduler/docs/source/cli.rst

.. Licensed to the Apache Software Foundation (ASF) under one
   or more contributor license agreements.  See the NOTICE file
   distributed with this work for additional information
   regarding copyright ownership.  The ASF licenses this file
   to you under the Apache License, Version 2.0 (the
   "License"); you may not use this file except in compliance
   with the License.  You may obtain a copy of the License at

..   http://www.apache.org/licenses/LICENSE-2.0

.. Unless required by applicable law or agreed to in writing,
   software distributed under the License is distributed on an
   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   KIND, either express or implied.  See the License for the
   specific language governing permissions and limitations
   under the License.

Command Line Interface
======================

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

Prepare
-------

You have to :ref:`install PyDolphinScheduler <start:installing pydolphinscheduler>` first before you using
its CLI

Usage
-----

Here is basic usage about the command line of *PyDolphinScheduler*

.. click:: pydolphinscheduler.cli.commands:cli
   :prog: pydolphinscheduler
   :nested: full