CLIシリアライゼーション・コマンド

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

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

Sitecoreシリアル化プラグインは、serializationコマンドに短い形式のserを提供します。

このコマンドは、アイテムのシリアル化を処理します。

シリアル化プラグインをインストールするには、次のコードを実行します。

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

使い

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

dotnet sitecore serialization [subcommand] [options]

または、次のようにコマンドの短縮形を使用することもできます。

dotnet sitecore ser [subcommand] [options]

サブコマンド

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

  • infoサブコマンド - シリアル化構成情報を表示します。

  • explainサブコマンド - コンテンツ項目のパスが含まれているかどうか、およびその理由を説明します。

  • pullサブコマンド - Sitecoreインスタンスからファイル システムにコンテンツ アイテムをシリアル化します。

  • pushサブコマンド - シリアル化されたコンテンツ アイテムをファイル システムからSitecoreインスタンスにプッシュします。

  • diffサブコマンド - 2つのSitecoreインスタンスのコンテンツ アイテムを比較します。

  • validateサブコマンド - シリアライズされたコンテンツ項目の有効性を検査します。--fix引数に関する一般的な問題を修正できます。

  • watchサブコマンド - Sitecoreインスタンス内のコンテンツ アイテムへの変更を監視し、ファイル システムへの変更を自動的にシリアル化します。

  • packageサブコマンド - シリアル化されたアイテムの作業パッケージに追加のコマンドを提供します。

  • package createサブコマンド - シリアル化されたアイテムのパッケージを作成します。

  • package installサブコマンド - シリアル化されたアイテムのパッケージを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) オプションでモジュールタグがサポートされています。サブコマンドpushpullもタグをサポートします。

infoサブコマンド

infoコマンドは、コンテンツのシリアライゼーションに関連して、ソリューションがどのようにセットアップされ、使用のために構成されているかについての情報を提供します。

このコマンドによって返される情報には、すべてのシリアル化モジュール構成のリストが含まれます。すべてのシリアル化モジュール構成について、情報には次のものが含まれます。

  • モジュール名。

  • モジュールの説明。

  • 名前とパスを持つアイテムのサブツリー。

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

オプション

必須。

形容

-i, --include <include>

いいえ

含めるモジュール構成を指定します。モジュール名、タグをサポートします。ワイルドカードと複数の値を使用できます。

-e, --exclude <exclude>

いいえ

明示的に除外するモジュール構成を指定します。モジュール名、タグをサポートします。ワイルドカードと複数の値を使用できます。

-c, --config <config>

いいえ

ルートsitecore.configディレクトリへのパス。デフォルト: 現在の作業ディレクトリ。

-v, --verbose

いいえ

追加の診断データとパフォーマンス データを書き込みます。

-t, --trace

いいえ

追加の診断データとパフォーマンス データを書き込みます。

-?, -h, --help

いいえ

コマンドに関する開発者のヘルプと使用情報を表示します。

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

命令

結果

dotnet sitecore ser info
> 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アイテム パスとオプションのデータベースに関する詳細なシリアル化関連情報を提供できます。

このサブコマンドは、以下の機能を提供します。

  • アイテム パスは、シリアル化モジュールのスコープ内にあります。

  • 特定のアイテム パスに対して許可される操作。

  • Path to serialization Module.json given path.

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

オプション

必須。

形容

-p, --path <path>

はい

説明するアイテムのパス。

-d, --database <database>

いいえ

説明するアイテムパスのデータベース。デフォルト: master

-c, --config <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 <environment-name>

いいえ

使用する名前付きSitecore環境。デフォルト: 'default';

-i, --include <include>

いいえ

含めるモジュール構成を指定します。モジュール名、タグをサポートします。ワイルドカードと複数の値を使用できます。

-e, --exclude <exclude>

いいえ

明示的に除外するモジュール構成を指定します。モジュール名、タグをサポートします。ワイルドカードと複数の値を使用できます。

-w, --what-if

いいえ

操作に関連するコマンドを実行せずにリストします。

メモ

-- what-ifオプションの詳細については、Sitecore CLIと 'what-if' フラグのビデオを参照してください。

-s, --skip-validation

いいえ

同期する前にファイルシステムの整合性検証をスキップします。

-c, --config <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サブコマンド

pushコマンドは、ディスク上の .ymlファイルとしてシリアル化されたアイテムを取得し、それらを宛先のSitecoreインスタンスにプッシュします。プッシュ操作では、シリアル化Module.jsonファイルを使用して、シリアル化プロセスに含まれる項目を決定します。プッシュ操作中、シリアル化エンジンはファイル システム上の既存のシリアル化されたアイテムを評価し、ソースSitecoreインスタンス内の同じアイテムの詳細な比較を実行します。

このコマンドには、昇格されたアクセス許可が必要です。

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

オプション

必須。

形容

-n, --environment-name <environment-name>

いいえ

使用する名前付きSitecore環境。デフォルト: 'default'

-i, --include <include>

いいえ

含めるモジュール構成を指定します。モジュール名、タグをサポートします。ワイルドカードと複数の値を使用できます。

-e, --exclude <exclude>

いいえ

明示的に除外するモジュール構成を指定します。モジュール名、タグをサポートします。ワイルドカードと複数の値を使用できます。

-w, --what-if

いいえ

操作に関連するコマンドを実行せずにリストします。

-s, --skip-validation

いいえ

同期前にファイル・システムの整合性検証をスキップします。

-c, --config <config>

いいえ

ルートsitecore.configディレクトリへのパス。デフォルト: 現在の作業ディレクトリ。

-v, --verbose

いいえ

追加の診断データとパフォーマンス データを書き込みます。

-t, --trace

いいえ

追加の診断データとパフォーマンス データを書き込みます。

-fr, --force

いいえ

エラーの代わりに警告を表示します。警告の原因となっている項目をスキップし、シリアル化を続行します。

--use-debug-signatures

いいえ

デバッグ (ハッシュ化されていない) 項目署名を使用して、ハッシュの不一致を診断します。だいぶ遅くなります。

-p, --publish

いいえ

同期されたアイテムを公開します。Publishing Serviceとの併用は、パフォーマンスが低下するため、お勧めしません。

--pt, --targets <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 <source>

はい

比較のソースとして使用する名前付きSitecoreエンドポイント。

-d, --destination <destination>

はい

比較の宛先として使用する名前付きSitecoreエンドポイント。

-i, --include <include>

いいえ

含めるモジュール構成を指定します。モジュール名、タグをサポートします。ワイルドカードと複数の値を使用できます。

-e, --exclude <exclude>

いいえ

明示的に除外するモジュール構成を指定します。モジュール名、タグをサポートします。ワイルドカードと複数の値を使用できます。

-p, --path <path>

いいえ

比較するアイテムのパス (包含/除外の代わりに)。

--source-database <source-database>

いいえ

ソースデータベース ( --pathと併用する場合)。

--destination-database <destination-database>

いいえ

宛先データベース ( --pathと共に使用する場合)。

--push

いいえ

検出された差分を宛先に適用します。

-c, --config <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)引数オプション フラグを使用すると、コマンドは特定された問題の自動修正を試みることができます。このサブコマンドは、シリアライゼーション・ファイルで構成されたファイル・システム上のすべてのシリアライズされたパスとサブツリーを評価しModule.jsonファイル・システムに対して以下の検査を実行します。

  • 物理パスが無効です。

  • 孤立した親ID。

  • 含まれていないアイテム。

  • 空のフォルダ。

  • アイテムIDが重複しています。

  • 一意でないパス。

手記

詳細については、「 シリアル化されたコンテンツ項目の検証」を参照してください。

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

オプション

必須。

形容

-i, --include <include>

いいえ

含めるモジュール構成を指定します。モジュール名、タグをサポートします。ワイルドカードと複数の値を使用できます。

-e, --exclude <exclude>

いいえ

明示的に除外するモジュール構成を指定します。モジュール名、タグをサポートします。ワイルドカードと複数の値を使用できます。

-f, --fix

いいえ

シリアル化されたアイテムの検証時に、可能な修正操作を実行します。

大事な

--fix (-f)オプションを使用すると、ローカルファイルを削除できます。

-c, --config <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サブコマンド

watchサブコマンドは、Sitecoreインスタンス内のコンテンツ アイテムへの変更を監視し、ファイル システムへの変更を自動的にシリアル化します。

このコマンドには、昇格されたアクセス許可が必要です。

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

オプション

必須。

形容

-n, --environment-name <environment-name>

いいえ

使用する名前付きSitecore環境。デフォルト: 'default';

-i, --include <include>

いいえ

含めるモジュール構成を指定します。モジュール名、タグをサポートします。ワイルドカードと複数の値を使用できます。

-e, --exclude <exclude>

いいえ

明示的に除外するモジュール構成を指定します。モジュール名、タグをサポートします。ワイルドカードと複数の値を使用できます。

-s, --skip-pull

いいえ

ウォッチャーを開始する前に、Sitecoreからのデータの取得をスキップします。

--allow-file-changes

いいえ

ファイルが変更された場合は、引き続き監視します。

大事な

このオプションを使用すると、基になる状態が変更された場合にツリーが破損する可能性があります。

このオプションは、変更されていないシリアル化されたファイルに他のプログラムが触れる場合にのみ使用してください。

-fr, --force

いいえ

エラーの代わりに警告を表示します。警告の原因となっている項目をスキップし、シリアル化を続行します。

-c, --config <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サブコマンド

packageサブコマンド (短縮形pkg) は、パッケージ固有の操作に対して、次のように追加のサブコマンドを提供します。

サブコマンド

形容

create

新しいシリアル番号付品目パッケージを作成します。

install

既存のアイテム パッケージをSitecoreにインストールします。

このコマンドには、昇格されたアクセス許可が必要です。

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

-?, -h, --help

コマンドに関する開発者のヘルプと使用情報を表示します。

package createサブコマンド

package createサブコマンドは、新しいシリアル番号付項目パッケージを作成します。

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

オプション

必須。

形容

-o, --output <output>

はい

作成後にパッケージを配置するためのパス。拡張機能を指定しない場合は、拡張機能が追加されます。

--overwrite

いいえ

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

-i, --include <include>

いいえ

含めるモジュール構成を指定します。モジュール名、タグをサポートします。ワイルドカードと複数の値を使用できます。バージョン4.1.0以降では、シリアル化モジュールで指定されたrolesもシリアル化されます。

-e, --exclude <exclude>

いいえ

明示的に除外するモジュール構成を指定します。モジュール名、タグをサポートします。ワイルドカードと複数の値を使用できます。

-c, --config <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

アウトプット:

[role] [A] Role DevEx\Product Admin is created successfully. 
[role] [A] Role DevEx\Product Merchandiser is created successfully.
[roles] Synced 2 roles completed.

package installサブコマンド

package installサブコマンドは、既存のアイテム パッケージをSitecoreにインストールします。

このコマンドには、昇格されたアクセス許可が必要です。

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

オプション

必須。

形容

-f, --package <package>

はい

インストールするパッケージへのパス。

--auth, --authority <authority>

いいえ

環境のID機関 (IDサーバーやAADテナントURLなど)。

--cm <cm>

いいえ

接続先のSitecoreコンテンツ管理ホスト名。

--client-id <client-id>

いいえ

送信するOAuth ClientID。デフォルトでは、デバイス認証は 'Device' <>、クライアント資格情報は 'SitecoreCLIServer' です。

--client-secret <client-secret>

いいえ

送信するOAuth ClientID。デフォルトでは、デバイス認証は 'Device' <>、クライアント資格情報は 'SitecoreCLIServer' です。

-n, --environment-name <environment-name>

いいえ

使用する名前付きSitecore環境。デフォルト: 'default'

-w, --what-if

いいえ

操作に関連するコマンドを実行せずにリストします。

-i, --include <include>

いいえ

含めるモジュール構成を指定します。モジュール名、タグをサポートします。ワイルドカードと複数の値を使用できます。

-e, --exclude <exclude>

いいえ

明示的に除外するモジュール構成を指定します。モジュール名、タグをサポートします。ワイルドカードと複数の値を使用できます。

-c, --config <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インスタンスにインストールされました。

この記事を改善するための提案がある場合は、 お知らせください!