CLI plugin コマンド

Current version: 10.2

Sitecore CLI には plugin コマンドが含まれています。このコマンドは、追加の CLI コマンドを含むプラグインを管理します。

注記

ターミナルに表示されるバージョンは、入手可能な最新の公式リリースです。

使用方法

次のコマンドを使用できます。

RequestResponse
dotnet sitecore plugin [subcommand] [options]

サブコマンド

次のサブコマンドを使用できます。

init サブコマンド

init サブコマンドはデフォルト プラグインを初期化します。

init サブコマンドでは、次のオプションを使用できます。

オプション

必須?

説明

-c, --config

いいえ

sitecore.json 設定ファイルへのパス。デフォルト: 現在の作業ディレクトリ。

--version

いいえ

インストールするデフォルト プラグインのバージョン。指定されていない場合、CLI は CLI バージョンと一致するプラグインのバージョンをインストールします。

--overwrite

いいえ

既存のプラグインの上書き/更新を許可します。以前にインストールされていないプラグインは、最新バージョンまたは指定されたバージョンでインストールされます。

--prerelease

いいえ

デフォルト プラグインのプレリリース バージョンを許可します。

-v, --verbose

いいえ

追加の診断およびパフォーマンス データを報告します。

-t, --trace

いいえ

追加の診断およびパフォーマンス データを報告します。

-?, -h, --help

いいえ

コマンドのヘルプ。

init サブコマンドの使用例は、次のとおりです。

コマンド

結果

dotnet sitecore plugin init

出力:

RequestResponse
Successfully installed version 4.1.0 of plugin Sitecore.DevEx.Extensibility.Serialization
Successfully installed version 4.1.0 of plugin Sitecore.DevEx.Extensibility.Publishing
Successfully installed version 4.1.0 of plugin Sitecore.DevEx.Extensibility.Indexing
Successfully installed version 4.1.0 of plugin Sitecore.DevEx.Extensibility.ResourcePackage
注記

デフォルト プラグインがすでに存在する場合、CLI は、たとえば、Sitecore.DevEx.Extensibility.Serialization はすでにインストール済みですという通知をするメッセージを表示します。

dotnet sitecore plugin init --version 5.0.0

出力:

RequestResponse
Successfully installed version 5.0.0 of plugin Sitecore.DevEx.Extensibility.Serialization
Successfully installed version 5.0.0 of plugin Sitecore.DevEx.Extensibility.Publishing
Successfully installed version 5.0.0 of plugin Sitecore.DevEx.Extensibility.Indexing
Successfully installed version 5.0.0 of plugin Sitecore.DevEx.Extensibility.ResourcePackage

dotnet sitecore plugin init --version 6.0.0 --overwrite

出力:

RequestResponse
Successfully updated to version 6.0.0 of plugin Sitecore.DevEx.Extensibility.Serialization
Successfully updated to version 6.0.0 of plugin Sitecore.DevEx.Extensibility.Publishing
Successfully installed version 6.0.0 of plugin Sitecore.DevEx.Extensibility.Indexing
Successfully installed version 6.0.0 of plugin Sitecore.DevEx.Extensibility.ResourcePackage

add サブコマンド

add サブコマンドでは、次のオプションを使用できます。

オプション

必須?

説明

-c, --config

いいえ

sitecore.json 設定ファイルへのパス。デフォルト: 現在の作業ディレクトリ。

-n, --name

はい

現在のプロジェクトにインストールするプラグインの名前。

--version

いいえ

インストールするプラグインのバージョン。バージョンが指定されていない場合、CLI は最新バージョンをインストールします。

-v, --verbose

いいえ

追加の診断およびパフォーマンス データを報告します。

-t, --trace

いいえ

追加の診断およびパフォーマンス データを報告します。

-?, -h, --help

いいえ

コマンドのヘルプ。

add サブコマンドの使用例は、次のとおりです。

コマンド

結果

dotnet sitecore plugin add -n Sitecore.DevEx.Extensibility.Serialization

出力:

RequestResponse
Successfully installed version 4.0.0 of plugin Sitecore.DevEx.Extensibility.Serialization
注記

version オプションを指定しない場合、CLI は最新バージョンをインストールします。すでにインストールされているものよりも高いプラグイン バージョンを指定すると、CLI は既存のプラグインを新しいバージョンに更新します。

パッケージが存在しない場合、CLI は通知するメッセージを表示します。

dotnet sitecore plugin add -n Sitecore.DevEx.Extensibility.Serialization --version 4.0.0

出力:

RequestResponse
Successfully installed version 4.0.0 of plugin Sitecore.DevEx.Extensibility.Serialization

remove サブコマンド

remove サブコマンドでは、次のオプションを使用できます。

オプション

必須?

説明

-c, --config

いいえ

sitecore.json 設定ファイルへのパス。デフォルト: 現在の作業ディレクトリ。

-n, --name

はい

現在のプロジェクトにインストールするプラグインの名前。

-v, --verbose

いいえ

追加の診断およびパフォーマンス データを報告します。

-t, --trace

いいえ

追加の診断およびパフォーマンス データを報告します。

-?, -h, --help

いいえ

コマンドのヘルプ。

remove サブコマンドの使用例は、次のとおりです。

コマンド

結果

dotnet sitecore plugin remove -n Sitecore.DevEx.Extensibility.Serialization

出力:

RequestResponse
Successfully deleted version 4.0.0 of plugin Sitecore.DevEx.Extensibility.Serialization
注記

プラグインが存在しない場合、CLI は、たとえば、プラグイン Sitecore.DevEx.Extensibility.PluginDoesNotExist はインストールされていないようですという通知をするメッセージを表示します。

list サブコマンド

list サブコマンドでは、次のオプションを使用できます。

オプション

必須?

説明

-c, --config

いいえ

sitecore.json 設定ファイルへのパス。デフォルト: 現在の作業ディレクトリ。

-v, --verbose

いいえ

追加の診断およびパフォーマンス データを報告します。

-t, --trace

いいえ

追加の診断およびパフォーマンス データを報告します。

-?, -h, --help

いいえ

コマンドのヘルプ。

list サブコマンドの例を次に示します。

コマンド

結果

dotnet sitecore plugin list

出力:

RequestResponse
List of plugins: 
Sitecore.DevEx.Extensibility.Indexing v.4.0.0
Sitecore.DevEx.Extensibility.Publishing v.4.0.0
Sitecore.DevEx.Extensibility.ResourcePackage v.4.0.0
Sitecore.DevEx.Extensibility.Serialization v.4.0.0            

Do you have some feedback for us?

If you have suggestions for improving this article,