Introduction

This article introduces the main commands of Kedro.

Global CLI

The following commands can be run from any directory.

• kedro --help: check Kedro help
• kedro --version: check Kedro version
• kedro docs: open a browser and go to the Kedro documentation
• kedro new: create a new project

Project-local CLI

The following commands must be executed from the project root directory.

• kedro catalog list: displays a list of datasets per pipeline
• kedro catalog list --pipeline "ds,de": list datasets for a specific pipeline
• kedro catalog create --pipeline <pipeline_name>: create a YAML file for a DataCatalog
• kedro ipython: launch IPython
• kedro jupyter lab: launch Jupyter Lab
• kedro jupyter notebook: launch Jupyter Notebook
• kedro jupyter convert notebooks/my_notebook.ipynb: copy the notebook code
• kedro package: package the project in the dist/ folder
• kedro pipeline create <pipeline_name>: create a pipeline
• kedro pipeline delete <pipeline_name>: delete a pipeline
• kedro registry describe <pipeline_name>: display pipeline description
• kedro registry list: display list of registered pipelines
• kedro run: run a pipeline

project-local CLI (deprecated)

The following commands are deprecated from version 0.19.0.

• kedro build-docs: create HTML documentation
• kedro lint: apply black, flake8, and isort
• kedro test: run pytest

References

https://kedro.readthedocs.io/en/stable/development/commands_reference.html#build-the-project-documentation