1. Sitecoreコマンド ライン インターフェイス リファレンス

CLIのitemresコマンド

Version:
日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

Sitecore Items as Resourcesプラグインには、itemresコマンドが含まれています。このコマンドは、構成可能なオプションを使用して、リソースファイルにアイテムパッケージを作成します。

Items as Resourcesプラグインをインストールするには、次のコードを実行します。

dotnet sitecore plugin add -n Sitecore.DevEx.Extensibility.ResourcePackage --version <version>

使い

このコマンドは、次のように使用できます。

dotnet sitecore itemres [subcommand] [options]

サブコマンド

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

  • create - リソース パッケージを作成します。

  • unicorn - Unicornリソースパッケージを作成します。

  • cleanup - .datファイルに含まれるデータベース項目をクリーンアップします。両方のエントリの項目データが等しい場合。このサブコマンドは、CLI 4.1以降で使用できます。

createサブコマンド

createサブコマンドは、新しい項目とリソースのパッケージを作成します。CLIは、規則 (items.{databaseName}.{providedName}.dat) に基づいてパッケージに名前を付けます。

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

オプション

形容

-o, --output <OUTPUT>

必須。

出力するパッケージパス(提供されていない場合は拡張子が追加されます)。

--overwrite <OVERWRITE>

既存のパッケージを上書きします。

-i, --include <INCLUDE>

モジュール構成を含めます。ワイルドカードと複数の値を使用できます。

-e, --exclude <EXCLUDE>

モジュール設定を明示的に除外します。ワイルドカードと複数の値を使用できます。

-c, --config <CONFIG>

ルートsitecore.configディレクトリへのパス。

デフォルト: 現在の作業ディレクトリ。

-v, --verbose

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

-t, --trace

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

-?, -h, --help

コマンドのヘルプ。

次に、createサブコマンドの使用例を示します。

命令

結果

dotnet sitecore itemres create -o TestPackage

items.{databaseName}.TestPackage.datファイルを作成します。このファイルには、すべてのモジュールが含まれています。

dotnet sitecore itemres create -o test/TestPackage

testフォルダにitems.{databaseName}.TestPackage.datファイルを作成します。このファイルには、すべてのモジュールが含まれています。

重複した名前でTestPackageを作成しようとします。

dotnet sitecore itemres create -o TestPackage

パッケージを作成せず、次のメッセージを返します。

"The output path items.{databaseName}.TestPackage.dat already existed, but Overwrite was false."

重複した名前でTestPackageを作成しようとします。

dotnet sitecore itemres create -o TestPackage --overwrite

パッケージを作成して上書きします。

dotnet sitecore itemres create -o TestPackage -i Project.Content.Test

パッケージを作成し、Project.Content.Testモジュールのみを含めます。

dotnet sitecore itemres create -o TestPackage -i Project.Content.Test, Project.Content

パッケージを作成し、Project.Content.TestモジュールとProject.Contentモジュールのみを含めます。

dotnet sitecore itemres create -o TestPackage -i *Test

パッケージを作成し、Project.Content.Testモジュールのみを含めます。ワイルドカードのプレフィックスが付きます。

dotnet sitecore itemres create -o TestPackage -i *Test*

パッケージを作成し、Project.Content.TestモジュールとProject.Content.Test1モジュールのみを含めます。これには、周囲のワイルドカードが含まれます。

dotnet sitecore itemres create -o TestPackage -i Project*

パッケージを作成し、Project.Content、Project.Content.Test、Project.Content.Test1の各モジュールを含めます。これにはワイルドカード・サフィックスが付いています。

dotnet sitecore itemres create -o TestPackage -e Project.Content.Test

パッケージを作成し、Project.ContentモジュールとProject.Content.Test1モジュールのみを含めます。 Project.Content.Testモジュールは除きます。

dotnet sitecore itemres create -o TestPackage -e Project.Content.Test, Project.Content

パッケージを作成し、Project.ContentモジュールとProject.Content.Testモジュールを除くProject.Content.Test1モジュールのみを含めます。

dotnet sitecore itemres create -o TestPackage -e *Test

パッケージを作成し、ワイルドカード プレフィックスを持つProject.Content.Testモジュールを除く、Project.ContentモジュールとProject.Content.Test1モジュールのみを含めます。

dotnet sitecore itemres create -o TestPackage -e *Test*

パッケージを作成し、Project.Contentモジュールのみを含めます。 Project.Content.TestモジュールとProject.Content.Test1モジュールとその前後のワイルドカードは除きます。

dotnet sitecore itemres create -o TestPackage -e Project*

パッケージを作成し、ワイルドカード接尾辞を持つProject.Content、Project.Content.Test 、およびProject.Content.Test1モジュールを除外します。

dotnet sitecore itemres create -o TestPackage -i Project* -e Project.Content.Test

パッケージを作成し、ワイルドカード接尾辞を持つProject.ContentモジュールとProject.Content.Test1モジュールを含め、Project.Content.Testモジュールを除外します。

dotnet sitecore itemres create -o TestPackage -i Project.Content.Test -e Project.Content.Test

パッケージを作成せず、次のメッセージを返します。

The include and exclude options contain the same modules at the same time

samplesフォルダからTestPackageを作成してみてください。

dotnet sitecore itemres create -o TestPackage

パッケージを作成せず、次のメッセージを返します。

error: Couldn't resolve a root configuration file (sitecore.json) in the current or any parent directory. Looks like the command might have been executed outside a Sitecore project?

samplesフォルダからTestPackageを作成してみてください。

dotnet sitecore itemres create -o TestPackage -c Prototype/

samplesフォルダにパッケージを作成します。

dotnet sitecore itemres create -o TestPackage -v

ルート設定パスやパフォーマンスのあるノードの数など、追加の診断データとパフォーマンスデータを作成します (例: 73ms (8.1ms/ノード)。

dotnet sitecore itemres create -o TestPackage -t

FSIndex: Loaded filesystem indices in 70ms (9 metadata) や1983ms (9 items; 220.3ms/node) などの1ツリーのパッケージの作成など、追加の診断データとパフォーマンス データを作成します。

ユニコーンのサブコマンド

unicornサブコマンドは、Unicornシリアライゼーションから新しいアイテムとリソースのパッケージを、特定の名前形式items.{databaseName}.{providedName}.datで作成します。

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

オプション

形容

-p, --path <INCLUDE>

必須。

ユニコーンのシリアル化への道。

-o, --output <OUTPUT>

必須。

出力するパッケージパス(提供されていない場合は拡張子が追加されます)。複数の値を使用できます。

--overwrite <OVERWRITE>

既存のパッケージを上書きします。

-c, --config <CONFIG>

ルートsitecore.configディレクトリへのパス。

デフォルト: 現在の作業ディレクトリ。

-v, --verbose

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

-t, --trace

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

-?, -h, --help

コマンドのヘルプ。

次に、unicornサブコマンドの使用例を示します。

命令

結果

dotnet sitecore itemres unicorn -p "testItem" -o "TestPackage

items.{databaseName}.TestPackage.datファイルを作成します。

cleanupサブコマンド

cleanupサブコマンドは、.datファイル内のデータベース項目が両方の項目の項目データが等しい場合に、クリーンアップします。

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

オプション

形容

-f, --force

フィールド比較なしでアイテムのクリーンアップを強制します。バージョン5.1.28から使用可能です。

-w, --what-if

アイテムを削除せずにアイテムのクリーンアップをシミュレートします。バージョン5.1.28から使用可能です。

-p,--path

クリーンアップするSitecoreアイテム パスまたはGUID。Sitecore 10.3で --forceまたは --what-ifオプションを使用する場合は必要です。

-r,--recurse

指定したパスの下にあるすべての項目を再帰的にクリーンアップします。

-c, --config <CONFIG>

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

デフォルト: cwd。

-n, --environment-name <ENVIRONMENT_NAME>

使用する名前付きSitecore環境。

デフォルト: 'default'。

-v, --verbose

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

-t, --trace

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

-?, -h, --help

コマンドのヘルプ。

次の表は、cleanupサブコマンドの使用例を示しています。

命令

結果

dotnet sitecore itemres cleanup

アウトプット：

Starting cleaning up databases. 
Processing...
Cleaning up databases is finished:
Cleanup of resource items is finished for 'master' database. Removed: 13 item(s).
Cleanup of resource items is finished for 'core' database. Removed: 3 item(s).

dotnet sitecore itemres cleanup --force

アウトプット：

Starting cleaning up databases.
Processing...
Cleaning up databases is finished:
Cleanup of resource items is finished for 'master' database. Removed: 1 item(s).
[master] [D] /sitecore/content/item1 (3d8f6795-1c4e-462d-8a81-be27b1aec5bd)
Cleanup of resource items is finished for 'core' database. Removed: 1 item(s).
[core] [D] /sitecore/content/item1 (3d8f6795-1c4e-462d-8a81-be27b1aec5bd)

dotnet sitecore itemres cleanup --what-if

アウトプット：

What if mode is active. No changes will be made.
Starting cleaning up databases.
Processing...
Cleaning up databases is finished:
Cleanup of resource items is finished for 'master' database. Removed: 1 item(s).
[master] [D] /sitecore/content/ItemResCleanUpContent (6f0a7dcd-5a69-409f-bf58-8ee64eda4515)
Cleanup of resource items is finished for 'core' database. Removed: 0 item(s).

dotnet sitecore itemres cleanup --path /sitecore/content/ItemResCleanUpContent --force

アウトプット：

Starting cleaning up databases.
Processing...
Cleaning up databases is finished:
Cleanup of resource items is finished for 'master' database. Removed: 1 item(s).
[master] [D] /sitecore/content/ItemResCleanUpContent (6f0a7dcd-5a69-409f-bf58-8ee64eda4515)
Cleanup of resource items is finished for 'core' database. Removed: 0 item(s).
この記事を改善するための提案がある場合は、 お知らせください!