NuGet を使用してコマンドライン インターフェイスを拡張する

Current version: 10.1

NuGet 拡張機能を使用すると、さまざまなプラグイン セットをプロジェクトに追加できます。プロジェクト ディレクトリの NuGet.config ファイルでプラグイン ソースを指定できます。

Sitecore コマンド ライン インターフェイス (CLI) プラグインは、https://sitecore.myget.org/gallery/sc-packages にパブリッシュされます。

CLI は、キャッシュのすべてのプラグインをプロジェクトの \.sitecore\package-cache\nuget ディレクトリにインストールします。

注記

キャッシュ フォルダーをクリーンアップすると、次の CLI 呼び出しですべての NuGet パッケージが復元されます。

CLI には plugin コマンドが組み込まれており、プロジェクトでプラグインを追加、更新、一覧表示、および削除できます。

プラグインの追加と更新

プロジェクトでプラグインを追加または更新するには:

  • 次のコマンドを実行します。

    RequestResponse
    sitecore plugin add -n <name of plugin> -v <version of plugin>
    注記

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

    パッケージが存在しない場合、CLI は次のようなメッセージを表示します。Sitecore.DevEx.Extensibility.Serialization プラグインのバージョン 3.0.0 が既にインストールされています。

オプション

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

オプション

必須?

デフォルト

説明

-c, --config

なし

cwd

sitecore.json 設定ファイルへのパス。

-n, --name

あり

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

--version

なし

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

-v, --verbose

なし

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

-t, --trace

なし

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

-?, -h, --help

なし

plugin add コマンドのヘルプ。

Sitecore.DevEx.Extensibility.Serialization プラグインの最新バージョンをインストールして追加/更新するには、次のコマンドを使用します。

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

出力:

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

Sitecore.DevEx.Extensibility.Serialization プラグインのバージョン 3.0.0 をインストールして追加/更新するには、次のコマンドを使用します。

RequestResponse
sitecore plugin add -n Sitecore.DevEx.Extensibility.Serialization --version 3.0.0

出力:

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

プラグインを削除する

プロジェクトからプラグインを削除するには:

  • 次のコマンドを実行します。

    RequestResponse
    sitecore plugin remove -n <name of plugin>
    注記

    プラグインが存在しない場合、CLI は次のようなメッセージを表示します。プラグイン Sitecore.DevEx.Extensibility.PluginDoesNotExist はインストールされていません。

オプション

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

オプション

必須?

デフォルト

説明

-c, --config

なし

cwd

sitecore.json 設定ファイルへのパス。

-n, --name

あり

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

-v, --verbose

なし

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

-t, --trace

なし

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

-?, -h, --help

なし

plugin remove コマンドのヘルプ。

Sitecore.DevEx.Extensibility.Serialization プラグインを削除するには、次のコマンドを使用します。

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

出力:

RequestResponse
Successfully deleted version 3.0.0 of plugin Sitecore.DevEx.Extensibility.Serialization

プラグインを一覧表示する

プロジェクトに含めることができるすべてのインストール済みプラグインを一覧表示するには:

  • 次のコマンドを実行します。

    RequestResponse
    sitecore plugin list

オプション

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

オプション

必須?

デフォルト

説明

-c, --config

なし

cwd

sitecore.json 設定ファイルへのパス。

-v, --verbose

なし

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

-t, --trace

なし

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

-?, -h, --help

なし

plugin list コマンドのヘルプ。

プラグインを一覧表示するには、次のコマンドを使用します。

RequestResponse
sitecore plugin list

出力:

RequestResponse
List of plugins: Sitecore.DevEx.Extensibility.Publishing v.3.0.0

Do you have some feedback for us?

If you have suggestions for improving this article,