はじめに

この記事では、Kedroの主要なコマンドを紹介します。

グローバル CLI

次のコマンドはどのディレクトリからでも実行することができます。

• kedro --help: Kedroのヘルプを確認する
• kedro --version: Kedroのバージョンを確認する
• kedro docs: ブラウザを開き、Kedroのドキュメントへ遷移する
• kedro new: 新規プロジェクトを作成する

プロジェクトローカル CLI

次のコマンドはプロジェクトのルートディレクトリから実行する必要があります。

• kedro catalog list: パイプラインごとのデータセットの一覧を表示する
• kedro catalog list --pipeline "ds,de": 特定のパイプラインのデータセットのリストを表示する
• kedro catalog create --pipeline <pipeline_name>: DataCatalogのYAMLファイルを作成する
• kedro ipython: IPythonを起動する
• kedro jupyter lab: Jupyter Labを起動する
• kedro jupyter notebook: Jupyter Notebookを起動する
• kedro jupyter convert notebooks/my_notebook.ipynb: ノートブックのコードをコピーする
• kedro package: dist/フォルダにプロジェクトをパッケージングする
• kedro pipeline create <pipeline_name>: パイプラインを作成する
• kedro pipeline delete <pipeline_name>: パイプラインを削除する
• kedro registry describe <pipeline_name>: パイプラインの説明を表示する
• kedro registry list: 登録済みのパイプラインの一覧を表示する
• kedro run: パイプラインを実行する

プロジェクトローカル CLI（非推奨）

次のコマンドはバージョン0.19.0から非推奨になります。

• kedro build-docs: HTMLのドキュメントを作成する
• kedro lint: black、flake8、 isortを適用する
• kedro test: pytestを実行する

参考

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