--- title: "CLI itemresコマンド" slug: "the-cli-itemres-command" abstract: "DevEx CLIのitemresコマンドの説明で、リソースファイル内にアイテムパッケージを作成し、設定可能なオプションを持っています。" --- # CLI itemresコマンド [Sitecore Items as Resourcesプラグイン](https://doc.sitecore.com/sai/ja/developers/sitecoreai/sitecore-command-line-interface/plugins/items-as-resources-plugin.html "Items as Resources plugin")にはitemresコマンドが含まれています。このコマンドは、設定可能なオプションを持つリソースファイル内にアイテムパッケージを作成します。 Items as Resourcesプラグインをインストールするには、以下のコードを実行します。 dotnet sitecore plugin add -n Sitecore.DevEx.Extensibility.ResourcePackage --version ## 使用例 コマンドの使い方は以下の通りです: dotnet sitecore itemres subcommand options ## サブコマンド 以下のサブコマンドを使用できます: - create - リソースパッケージを作成すること。 - unicorn - ユニコーンリソースパッケージを作成すること。 - cleanup - .datファイルに含まれるデータベース項目を、両方のエントリの項目データが等しい場合にクリーンアップします。このサブコマンドはCLI 4.1以降で利用可能です。 ### createサブコマンド createサブコマンドは新しいアイテムおよびリソースパッケージを作成します。CLIはこのパッケージを慣例items.{databaseName}.{providedName}.datに基づいて名前付けします。 createサブコマンドで以下のオプションを使用できます: - \-o, --output - 必須。パッケージから出力までのパス。延長が提供されない場合は追加されます。 - \--overwrite - 既存のパッケージを上書きする。 - \-i, --include - モジュール構成を含めること。ワイルドカードや複数の値を許容しています。 - \-e, --exclude - モジュール構成を明示的に除外する。ワイルドカードや複数の値を許容しています。 - \-c, --config - ルート sitecore.config ディレクトリへのパス。デフォルト:現在の作業ディレクトリ。 - \-v, --verbose - 追加の診断および性能データを報告します。 - \-t, --trace - 追加の診断および性能データを報告します。 - \-?, -h, --help - コマンドに手伝ってくれ。 例: #### すべてのモジュールを含むパッケージを作成します 指揮: dotnet sitecore itemres create -o TestPackage 結果: items.{databaseName}.TestPackage.datファイルが作成されます。ファイルにはすべてのモジュールが含まれています。 #### 特定のフォルダにパッケージを作成する 指揮: dotnet sitecore itemres create -o test/TestPackage 結果:testフォルダ内にitems.{databaseName}.TestPackage.datファイルを作成します。ファイルにはすべてのモジュールが含まれています。 #### 上書きなしのパッケージ名の重複 指揮: dotnet sitecore itemres create -o TestPackage 結果: The output path items.{databaseName}.TestPackage.dat already existed, but Overwrite was false. #### パッケージ名を上書きして複製する 指揮: 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.Testモジュールを除くProject.ContentとProject.Content.Test1モジュールのみを含みます。 指揮: 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 #### Sitecoreプロジェクトの外部から実行 指揮: 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? 指揮: dotnet sitecore itemres create -o TestPackage -c Prototype/ 結果: samplesフォルダ内にパッケージを作成します。 #### 診断出力の生成 指揮: dotnet sitecore itemres create -o TestPackage -v 結果:ルート設定パスやパフォーマンスを持つノード数などの追加の診断およびパフォーマンスデータを作成します。例えば73ms (8.1ms/node)。 指揮: dotnet sitecore itemres create -o TestPackage -t 結果: FSIndex: Loaded filesystem indices in、例えば70ms (9 metadata)、またはcreated package of 1 trees in、例えば1983ms (9 items; 220.3ms/node)などの追加の診断および性能データを作成します。 ### ユニコーン副司令部 unicornサブコマンドはUnicornシリアライズから特定の名前フォーマットitems.{databaseName}.{providedName}.datで新しいアイテムおよびリソースパッケージを作成します。 unicornサブコマンドで以下のオプションを使用できます: - \-p, --path - 必須。ユニコーンの連続載への道。 - \-o, --output - 必須。パッケージから出力までのパス。延長が提供されない場合は追加されます。複数の値を設定できます。 - \--overwrite - 既存のパッケージを上書きする。 - \-c, --config - ルート sitecore.config ディレクトリへのパス。デフォルト:現在の作業ディレクトリ。 - \-v, --verbose - 追加の診断および性能データを報告します。 - \-t, --trace - 追加の診断および性能データを報告します。 - \-?, -h, --help - コマンドに手伝ってくれ。 例: 指揮: dotnet sitecore itemres unicorn -p "testItem" -o "TestPackage" 結果: items.{databaseName}.TestPackage.datファイルが作成されます。 ### 清掃小隊 cleanupサブコマンドは、両方のエントリの項目データが等しい場合に、.datファイルのデータベース項目を整理します。 > !警告このコマンドはキャッシュの完全なクリーンアップを引き起こし、パフォーマンス低下を引き起こすことがあります。メンテナンス期間中に実行すべきです。 cleanupサブコマンドで以下のオプションを使用できます: - \-f, --force - フィールド比較なしにアイテムのクリーンアップを強制する。バージョン5.1.28から利用可能。 - \-w, --what-if - アイテムを削除せずにアイテムのクリーンアップをシミュレートします。バージョン5.1.28から利用可能。 - \-p, --path - SitecoreアイテムパスまたはGUIDでクリーンアップ。 \--force または \--what-if オプションを使う場合、Sitecore 10.3に必須です。 - \-r, --recurse - 指定された経路内のすべてのアイテムを再帰的にクリーンアップする。 - \-c, --config - sitecore.json 設定ファイルへのパス。デフォルト: cwd。 - \-n, --environment-name - 使用可能な名前付きのSitecore環境。デフォルト: default。 - \-v, --verbose - 追加の診断および性能データを報告します。 - \-t, --trace - 追加の診断および性能データを報告します。 - \-?, -h, --help - コマンドに手伝ってくれ。 > !ヒント \--what-ifオプションを使って、アイテムが上書きされるかどうかや保管場所を特定することができます。 例: #### 対象品はすべて片付けてください 指揮: 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).