--- title: "CLIのシリアライゼーションコマンド" slug: "the-cli-serialization-command" abstract: "項目をシリアライズするSitecore CLIのシリアライズコマンドの参考文献です。" --- # CLIのシリアライゼーションコマンド Sitecoreシリアライゼーションプラグインは、短縮形serを含むserializationコマンドを提供します。 このコマンドはアイテムのシリアライズを処理します。 シリアライゼーションプラグインをインストールするには、以下のコードを実行します: dotnet sitecore plugin add -n Sitecore.DevEx.Extensibility.Serialization ## 使用例 コマンドの使い方は以下の通りです: dotnet sitecore serialization subcommand options または、以下の略称を使うこともできます: dotnet sitecore ser subcommand options ## サブコマンド 以下のサブコマンドを使用できます: - [infoサブコマンド](https://doc.sitecore.com/xp/ja/developers/103/developer-tools/the-cli-serialization-command.html#UUID-a0794c45-7d08-d440-7bff-416610cc2c71_section-idm4556665106350432792957280148 "The info subcommand")はシリアライズの設定情報を表示します。 - [explainサブコマンド](https://doc.sitecore.com/xp/ja/developers/103/developer-tools/the-cli-serialization-command.html#UUID-a0794c45-7d08-d440-7bff-416610cc2c71_section-idm4609582190612832792957138232 "The explain subcommand") - コンテンツアイテムパスが含まれているかどうか、その理由を説明します。 - [pullサブコマンド](https://doc.sitecore.com/xp/ja/developers/103/developer-tools/the-cli-serialization-command.html#UUID-a0794c45-7d08-d440-7bff-416610cc2c71_section-idm4609582433057632792957482901 "The pull subcommand")は、Sitecoreインスタンスからファイルシステムへのコンテンツ項目をシリアライズします。 - [pushサブコマンド](https://doc.sitecore.com/xp/ja/developers/103/developer-tools/the-cli-serialization-command.html#UUID-a0794c45-7d08-d440-7bff-416610cc2c71_section-idm4544533837987232792957859689 "The push subcommand")は、ファイルシステムからSitecoreインスタンスへシリアライズされたコンテンツ項目をプッシュします。 - [diffサブコマンド](https://doc.sitecore.com/xp/ja/developers/103/developer-tools/the-cli-serialization-command.html#UUID-a0794c45-7d08-d440-7bff-416610cc2c71_section-idm4556665117923232792958045556 "The diff subcommand") - 2つのSitecoreインスタンスの内容項目を比較します。 - [validateサブコマンド](https://doc.sitecore.com/xp/ja/developers/103/developer-tools/the-cli-serialization-command.html#UUID-a0794c45-7d08-d440-7bff-416610cc2c71_section-idm4609582154825632792957760524 "The validate subcommand") - シリアル化されたコンテンツ項目の妥当性をチェックします。\--fix引数の一般的な問題を修正できます。 - [watchサブコマンド](https://doc.sitecore.com/xp/ja/developers/103/developer-tools/the-cli-serialization-command.html#UUID-a0794c45-7d08-d440-7bff-416610cc2c71_section-idm455665573495363279295823451 "The watch subcommand")は、Sitecoreインスタンス内のコンテンツ項目の変更を監視し、その変更を自動的にファイルシステムにシリアライズします。 - [packageサブコマンド](https://doc.sitecore.com/xp/ja/developers/103/developer-tools/the-cli-serialization-command.html#UUID-a0794c45-7d08-d440-7bff-416610cc2c71_section-idm4556665033134432792958335354 "The package subcommand") - シリアル化されたアイテムの動作するパッケージに追加コマンドを提供します。 - [package createサブコマンド](https://doc.sitecore.com/xp/ja/developers/103/developer-tools/the-cli-serialization-command.html#UUID-a0794c45-7d08-d440-7bff-416610cc2c71_section-idm4556665402577632792958434819 "The package create subcommand") - シリアル化されたアイテムのパッケージを作成します。 - [package installサブコマンド](https://doc.sitecore.com/xp/ja/developers/103/developer-tools/the-cli-serialization-command.html#UUID-a0794c45-7d08-d440-7bff-416610cc2c71_section-idm4609582163089632792958134581 "The package install subcommand") - Sitecoreインスタンスにシリア化されたアイテムのパッケージをインストールします。 バージョン4.0.0以降、いくつかのサブコマンドには既存のオプションに追加や改善が加えられています。以下のように: - バージョン4.0.0以降では、ほとんどのサブコマンドで \--exclude (\-e)オプションで除外フィールドを指定できます。 - バージョン4.0.0以降では、 push サブコマンドが \--targets (\-pt)オプションをサポートしています。 - バージョン4.1.0以降では、一部のサブコマンドが \--force (\-fr)オプションをサポートしており、エラーを引き起こすファイルをスキップしてエラーではなく警告を投げて操作を強制的に継続させます。このオプションはバージョン4.1.0以降で利用可能です。 - バージョン4.1.0以降では、 \--include (\-i)と \--exclude (\-e)オプションがモジュールタグをサポートしています。サブコマンド push と pull もタグをサポートしています。 ### 情報サブコマンド infoコマンドは、コンテンツシリアライズに関連するソリューションの設定や設定に関する情報を提供します。 コマンドで返される情報には、すべてのシリアライゼーションモジュール構成のリストが含まれます。すべてのシリアライゼーションモジュール構成について、情報には以下が含まれます: - モジュール名。 - モジュールの説明。 - 名前とパスを持つアイテムサブツリー。 infoサブコマンドで以下のオプションを使用できます: オプション 必須ですか? 概要 \-i, --include いいえ 含まれるモジュール構成を指定してください。モジュール名、タグをサポートしています。ワイルドカードや複数の値を許可しています。 \-e, --exclude いいえ 明示的に除外するモジュール構成を指定してください。モジュール名、タグをサポートしています。ワイルドカードや複数の値を許可しています。 \-c, --config いいえ ルートディレクトリへのパス sitecore.config 。デフォルト:現在の作業ディレクトリ。 \-v, --verbose いいえ 追加の診断データやパフォーマンスデータを書き込むこと。 \-t, --trace いいえ 追加の診断データやパフォーマンスデータを書き込むこと。 \-?, -h, --help いいえ 開発者のヘルプやコマンドの使用情報を表示します。 以下はinfoサブコマンドの使用例です: - コマンド:結果 - dotnet sitecore ser 情報: > sitecore ser info Maximum subtree-relative item path allowed: 100 Feature.BasicContent Subtrees: templates: /sitecore/templates/Feature/BasicContent renderings: /sitecore/layout/Renderings/Feature/BasicContent buttons: core:/sitecore/content/Applications/WebEdit/Custom Experience Buttons/BasicContent FieldsFilter Excludes: 0 Roles: 0 # ... Project.DemoContent An example of separating content into a separate module, so it can be excluded from deploy. Subtrees: content: /sitecore/content/Basic Company media: /sitecore/media library/Basic Company FieldsFilter Excludes: 1 Roles: 0 Excluded Fields From Default Serialization Config: FieldsFilter Excludes: 1 ### explainサブコマンド explainを使って、特定のSitecoreアイテムパスやオプションのデータベースに関する詳細なシリアライズ関連情報を提供できます。 サブコマンドは以下の内容を提供します。 - アイテムパスはすべてのシリアライズモジュールの範囲内にあります。 - 関連された項目パスに対して許容された操作。 - シリアライズへのパス Module.json 指定されたパスに設定されます。 explainサブコマンドで以下のオプションを使用できます: オプション 必須ですか? 概要 \-p, --path はい アイテムパスについて説明してください。 \-d, --database いいえ 説明のためのアイテムパスのデータベース。デフォルト: master。 \-c, --config いいえ ルートディレクトリへのパス sitecore.config 。デフォルト:現在の作業ディレクトリ。 \-v, --verbose いいえ 追加の診断データや性能データを書きましょう。 \-?, -h, --help いいえ 開発者のヘルプやコマンドの使用情報を表示します。 以下はexplainサブコマンドの使用例です。 - コマンド:結果 - モジュール構成に含まれていないパスを説明:dotnet sitecore ser explain --path "NOT\_INCLUDED\_PATH": Path master:NOT\_INCLUDED\_PATH is not included in any module configuration. - モジュール構成に含まれるパスを説明してください:dotnet sitecore ser explain --path "INCLUDED\_PATH": MODULE\_NAME INCLUDED\_PATH Item path matches subtree scope ItemAndDescendants. MODULE\_NAME INCLUDED\_PATH Subtree set allowed push operations CreateUpdateAndDelete MODULE\_NAME INCLUDED\_PATH Path master:INCLUDED\_PATH is included! Physical path:PATH\_TO\_YAML\_FILE ### pullサブコマンド pullサブコマンドはSitecoreからアイテムを取り出し、シリアライズし、特定のファイルシステムパス上の.ymlファイルとして保存します。サブコマンドはModule.jsonファイルを使ってシリアライズプロセスに含まれるアイテムを決定します。プル操作中、シリアライゼーションエンジンはディスク上の既存のシリアライズされたアイテムを評価し、ソースSitecoreインスタンス内の同じアイテムを詳細に比較します。 このコマンドには権限が上乗せされます。 pullサブコマンドで以下のオプションを使用できます: オプション 必須ですか? 概要 \-n, --environment-name いいえ 使用環境Sitecore名付けられています。デフォルト: 'default'; \-i, --include いいえ 含まれるモジュール構成を指定してください。モジュール名、タグをサポートしています。ワイルドカードや複数の値を許可しています。 \-e, --exclude いいえ 明示的に除外するモジュール構成を指定してください。モジュール名、タグをサポートしています。ワイルドカードや複数の値を許可しています。 \-w, --what-if いいえ 実行せずに操作に関わるコマンドをリストアップしてください。 \> \[!注\] \> \-- what-ifオプションの詳細については、ビデオ[Sitecore CLIと「もしも」フラグ](https://www.youtube.com/watch?v=4fSN4nfwojI)をご覧ください。 \-s, --skip-validation いいえ 同期前にファイルシステムの整合性検証を省略してください。 \-c, --config いいえ ルートディレクトリへのパス sitecore.config 。デフォルト:現在の作業ディレクトリ。 \-v, --verbose いいえ 追加の診断データやパフォーマンスデータを書き込むこと。 \-t, --trace いいえ 追加の診断データやパフォーマンスデータを書き込むこと。 \-fr, --force いいえ エラーの代わりに警告を表示する。警告の原因となるアイテムをスキップして、シリアル化を続けてください。 \--use-debug-signatures いいえ ハッシュミスマッチを診断するためにデバッグ(ハッシュされていない)アイテムシグネチャを使いましょう。はるかに遅くなります。 \-?, -h, --help いいえ 開発者のヘルプやコマンドの使用情報を表示します。 以下はpullサブコマンドの使用例です。 - コマンド:結果 - dotnet sitecore ser pull:構成内のすべてのSitecoreアイテムはディスク上でシリアライズされています。 - dotnet sitecore ser pull -i ModuleA ModuleB:ModuleAおよびModuleB構成からのすべてのSitecoreアイテムはディスク上でシリアライズされています。 - dotnet sitecore ser pull -i tags:\[tagA,tagB\]: tagAおよびtagBとしてタグ付けされたモジュールのすべてのSitecore項目はディスク上でシリアライズされています。 - dotnet sitecore ser pull -i tags:\[tagA,tagB\] ModuleA: tagA、tagB、ModuleA 構成としてタグ付けされたモジュールからのすべての Sitecore アイテムがディスク上でシリアライズされます。 ### プッシュサブコマンド pushコマンドは、ディスク上の.ymlファイルとしてシリアライズされたアイテムを受け取り、それを宛先Sitecoreインスタンスにプッシュします。プッシュ操作では、シリアライズModule.jsonファイルを使ってシリアライズプロセスに含まれるアイテムを特定します。プッシュ操作中、シリアライゼーションエンジンはファイルシステム上の既存のシリアライズされたアイテムを評価し、ソースSitecoreインスタンス内の同じアイテムを詳細に比較します。 このコマンドには権限が上乗せされます。 pushサブコマンドで以下のオプションを使用できます: オプション 必須ですか? 概要 \-n, --environment-name いいえ 使用Sitecore環境の名前付き。デフォルト: 'default'。 \-i, --include いいえ 含まれるモジュール構成を指定してください。モジュール名、タグをサポートしています。ワイルドカードや複数の値を許可しています。 \-e, --exclude いいえ 明示的に除外するモジュール構成を指定してください。モジュール名、タグをサポートしています。ワイルドカードや複数の値を許可しています。 \-w, --what-if いいえ 実行せずに操作に関わるコマンドをリストアップしてください。 \-s, --skip-validation いいえ 同期前にファイルシステムの整合性検証をスキップしてください。 \-c, --config いいえ ルートディレクトリへのパス sitecore.config 。デフォルト:現在の作業ディレクトリ。 \-v, --verbose いいえ 追加の診断データやパフォーマンスデータを書き込むこと。 \-t, --trace いいえ 追加の診断データやパフォーマンスデータを書き込むこと。 \-fr, --force いいえ エラーの代わりに警告を表示する。警告の原因となるアイテムをスキップして、シリアル化を続けてください。 \--use-debug-signatures いいえ ハッシュミスマッチを診断するためにデバッグ(ハッシュされていない)アイテムシグネチャを使いましょう。はるかに遅くなります。 \-p, --publish いいえ 同期されたアイテムを公開。パフォーマンス低下のため、Publishing Serviceでの使用は推奨されません。 \--pt, --targets いいえ 公開するターゲットデータベースの一覧。空白は web データベースに公開します。 \-?, -h, --help いいえ 開発者のヘルプやコマンドの使用情報を表示します。 以下はpushサブコマンドの使用例です。 - コマンド:結果 - dotnet sitecore ser push:構成からのすべてのSitecore項目がSitecoreインスタンスにプッシュされます。 - dotnet sitecore ser push -i ModuleA ModuleB: ModuleAおよびModuleB構成のすべてのSitecoreアイテムはSitecoreインスタンスにプッシュされます。 - dotnet sitecore ser push -i tags:\[tagA,tagB\]: tagAおよびtagB構成としてタグ付けされたモジュールのすべてのSitecoreアイテムがSitecoreインスタンスにプッシュされます。 - dotnet sitecore ser push -i tags:\[tagA,tagB\] ModuleA: tagA、tagB、ModuleA 構成としてタグ付けされたモジュールのすべての Sitecore アイテムが Sitecore インスタンスにプッシュされます。 ### diffサブコマンド diffサブコマンドは、ソースSitecoreインスタンスと宛先Sitecoreインスタンス間のシリアライズ項目を比較します。この操作はシリアライズ**Module.json**ファイルを用いて比較プロセスに含まれる項目を特定します。diffコマンド中、シリアライゼーションエンジンはソースSitecoreインスタンスと宛先Sitecoreインスタンス内のパスやアイテムの詳細な比較を行います。 このコマンドは、ソース環境とターゲット環境の両方で権限を昇格させる必要があります。 diffサブコマンドで以下のオプションを使用できます: オプション 必須ですか? 概要 \-s, --source はい 比較用のソースとして使うための名前付きSitecoreエンドポイント。 \-d, --destination はい 比較用の宛先として名前付きのSitecoreエンドポイントを用意しました。 \-i, --include いいえ 含まれるモジュール構成を指定してください。モジュール名、タグをサポートしています。ワイルドカードや複数の値を許可しています。 \-e, --exclude いいえ 明示的に除外するモジュール構成を指定してください。モジュール名、タグをサポートしています。ワイルドカードや複数の値を許可しています。 \-p, --path いいえ 比較する項目経路(含める・除外するのではなく)。 \--source-database いいえ ソースデータベース( \--pathと併用する場合)。 \--destination-database いいえ 宛先データベース( \--pathと併用した場合)。 \--push いいえ 検出した違いを宛先に適用します。 \-c, --config いいえ ルート sitecore.config ディレクトリへのパス。デフォルト:現在の作業ディレクトリ。 \-v, --verbose いいえ 追加の診断データやパフォーマンスデータを書き込むこと。 \-t, --trace いいえ 追加の診断データやパフォーマンスデータを書き込むこと。 \-?, -h, --help いいえ 開発者のヘルプやコマンドの使用情報を表示します。 以下はdiffサブコマンドの使用例です: - コマンド:結果 - dotnet sitecore ser diff -s SOURCE -d DESTINATION: DBNAME Discovered CHANGES\_COUNT changes after evaluating ITEMS\_COUNT total items. ### validateサブコマンド validateサブコマンドは、シリアル化されたアイテムやパスのファイルシステムの整合性を保証します。さらに、\--fix (-f) argument option flagを使用することで、特定された問題の自動訂正を試みることができます。サブコマンドは、シリアライズModule.jsonファイル上で設定されたファイルシステム上のすべてのシリアライズパスおよびサブツリーを評価し、ファイルシステムに対して以下のチェックを行います: - 物理的な経路が無効です。 - 孤児の親のID。 - 含まれていないアイテム。 - 空のフォルダ。 - アイテムIDを複製してください。 - 非ユニークパス。 > !注詳細については、「 [連載されたコンテンツの検証](https://doc.sitecore.com/xp/ja/developers/103/developer-tools/validate-serialized-content-items.html "Validate serialized content items")」をご覧ください。 validateサブコマンドで以下のオプションを使用できます: オプション 必須ですか? 概要 \-i, --include いいえ 含まれるモジュール構成を指定してください。モジュール名、タグをサポートしています。ワイルドカードや複数の値を許可しています。 \-e, --exclude いいえ 明示的に除外するモジュール構成を指定してください。モジュール名、タグをサポートしています。ワイルドカードや複数の値を許可しています。 \-f, --fix いいえ シリアライズされたアイテムの検証時に可能な修正操作を実行します。 \>\[!重要\] \> \--fix (-f) オプションを使うとローカルファイルを削除できます。 \-c, --config いいえ ルート sitecore.config ディレクトリへのパス。デフォルト:現在の作業ディレクトリ。 \-v, --verbose いいえ 追加の診断データやパフォーマンスデータを書き込むこと。 \-t, --trace いいえ 追加の診断データやパフォーマンスデータを書き込むこと。 \-?, -h, --help いいえ 開発者のヘルプやコマンドの使用情報を表示します。 以下はvalidateサブコマンドの使用例です: - コマンド:結果 - dotnet sitecore ser validate: Read-only validation is active. No fixes will be made. No errors were detected. - Dotnet SiteCore SER Validate --Fix: DUPLICATE ID: 5c069416-660c-4028-b5c8-c9f3ce3cb277 found in ... D ~\\FILE\_DUPLICATE.yml ... No errors were detected. ### ウォッチサブコマンド watchサブコマンドはSitecoreインスタンス内のコンテンツ項目の変更を監視し、その変更を自動的にファイルシステムにシリアライズします。 このコマンドには権限が上乗せされます。 watchサブコマンドで以下のオプションを使用できます: オプション 必須ですか? 概要 \-n, --environment-name いいえ 使用予定のSitecore環境。デフォルト:'default'; \-i, --include いいえ 含まれるモジュール構成を指定してください。モジュール名、タグをサポートしています。ワイルドカードや複数の値を許可しています。 \-e, --exclude いいえ 明示的に除外するモジュール構成を指定してください。モジュール名、タグをサポートしています。ワイルドカードや複数の値を許可しています。 \-s, --skip-pull いいえ ウォッチャーを起動する前にSitecoreからデータを取得するのは省略してください。 \--allow-file-changes いいえ ファイルが変わったら引き続き見てください。 \>\[!重要\] \> このオプションを使用すると、基となる状態が変更されると木の破損が生じる可能性があります。 \> このオプションは、他のプログラムがシリアライズされたファイルに触れた場合にのみ使用します。 \-fr, --force いいえ エラーの代わりに警告を表示する。警告の原因となるアイテムをスキップして、シリアル化を続けてください。 \-c, --config いいえ ルート sitecore.config ディレクトリへのパス。デフォルト:現在の作業ディレクトリ。 \-v, --verbose いいえ 追加の診断データやパフォーマンスデータを書き込むこと。 \-t, --trace いいえ 追加の診断データやパフォーマンスデータを書き込むこと。 \-?, -h, --help いいえ 開発者のヘルプやコマンドの使用情報を表示します。 以下はwatchサブコマンドの使用例です: - コマンド:結果 - Dotnet SiteCore SER Watch: Watcher is online! Changes made to serialized items will be automatically pulled. ### パッケージサブコマンド packageサブコマンド(略称pkg)は、パッケージ固有の操作のための追加のサブコマンドを提供します。以下のように: 副司令部 概要 create 新しいシリアル化されたアイテムパッケージを作成します。 install 既存のアイテムパッケージをSitecoreにインストールしてください。 このコマンドには権限が上乗せされます。 packageサブコマンドで以下のオプションを使用できます: \-?, -h, --help 開発者のヘルプやコマンドの使用情報を表示します。 ### package create subcommand package createサブコマンドは新しいシリアル化されたアイテムパッケージを作成します。 package createサブコマンドで以下のオプションを使用できます: オプション 必須ですか? 概要 \-o, --output はい 作成後にパッケージを配置するためのパス。拡張機能を提供しない場合は、あなたの代わりに追加されます。 \--overwrite いいえ 既存のパッケージを上書きすることを許可します。 \-i, --include いいえ 含まれるモジュール構成を指定します。モジュール名、タグをサポートします。ワイルドカードや複数の値が許可されています。バージョン4.1.0以降からは、シリアライゼーションモジュールで指定された roles もシリアライズされています。 \-e, --exclude いいえ 明示的に除外するモジュール構成を指定してください。モジュール名、タグをサポートしています。ワイルドカードや複数の値を許可しています。 \-c, --config いいえ ルート sitecore.config ディレクトリへのパス。デフォルト:現在の作業ディレクトリ。 \-v, --verbose いいえ 追加の診断データやパフォーマンスデータを書き込むこと。 \-t, --trace いいえ 追加の診断データやパフォーマンスデータを書き込むこと。 \-?, -h, --help いいえ 開発者のヘルプやコマンドの使用情報を表示します。 以下はpackage createサブコマンドの使用例です: - コマンド:結果 - dotnet sitecore ser pkg create -o FILE\_PATH: 指定された FILE\_PATHでパッケージが作成されました。 - ロールを使ったモジュールのシリアライズ:{ "namespace": "Feature.Products", "roles": \[ { "domain": "DevEx", "pattern": "Product" } \]}dotnet sitecore ser info --include Feature.Products -v: Output: role A Role DevEx\\Product Admin is created successfully. role A Role DevEx\\Product Merchandiser is created successfully. roles Synced 2 roles completed. ### パッケージのinstallサブコマンド package installサブコマンドは既存のアイテムパッケージをSitecoreにインストールします。 このコマンドには権限が上乗せされます。 package installサブコマンドで以下のオプションを使用できます: オプション 必須ですか? 概要 \-f, --package はい インストールするパッケージへのパス。 \--auth, --authority いいえ 環境の識別権限(アイデンティティサーバーやAADテナントURLなど)。 \--cm いいえ 接続先はSitecoreコンテンツ管理ホスト名です。 \--client-id いいえ 送信するOAuth ClientIDです。デバイス認証はデフォルトで 'Device' 、クライアント認証は 'SitecoreCLIServer' です。 \--client-secret いいえ 送信するOAuth ClientIDです。デバイス認証はデフォルトで 'Device' 、クライアント認証は 'SitecoreCLIServer' です。 \-n, --environment-name いいえ 使用Sitecore環境の名前付き。デフォルト: 'default'。 \-w, --what-if いいえ 実行せずに操作に関わるコマンドをリストアップしてください。 \-i, --include いいえ 含まれるモジュール構成を指定してください。モジュール名、タグをサポートしています。ワイルドカードや複数の値を許可しています。 \-e, --exclude いいえ 明示的に除外するモジュール構成を指定してください。モジュール名、タグをサポートしています。ワイルドカードや複数の値を許可しています。 \-c, --config いいえ ルートディレクトリへのパス sitecore.config 。デフォルト:現在の作業ディレクトリ。 \-v, --verbose いいえ 追加の診断データやパフォーマンスデータを書き込むこと。 \-t, --trace いいえ 追加の診断データやパフォーマンスデータを書き込むこと。 \-p, --publish いいえ 同期されたアイテムを公開する。 パフォーマンスの懸念から、Publishing Serviceではこのオプションの使用を避けることをお勧めします。 \-?, -h, --help いいえ 開発者のヘルプやコマンドの使用情報を表示します。 以下はpackage installサブコマンドの使用例です: - コマンド:結果 - dotnet sitecore ser pkg install -f FILE\_PATH: パッケージ FILE\_PATH はSitecoreインスタンスにインストールされました。