SXA CLI を使用したテーマの追加

Current version: 10.1

SXA CLI は、SXA プロジェクトのタスクを自動化するために役立つコマンド ライン ツールです。このトピックでは、SXA CLI を使用してテーマを追加する方法について説明します。これは、アセットをより詳細に制御したり、Git などのバージョン管理システムを使用したりする場合に便利です。

SXA CLI を使用してテーマを追加するには、node.js をインストールして、ノード パッケージ マネージャー (NPM) をグローバルにインストールしてください。

  1. コマンド プロンプト ターミナルを開き、レジストリをインストールします。

    npm config set @sxa:registry=https://sitecore.myget.org/F/sc-npm-packages/npm/

  2. npm のインストール コマンド (npm i -g @sxa/CLI) を使用して、SXA CLI をグローバル パッケージとしてインストールします。

SXA CLI を使用してテーマを追加するには、次の手順に従います。

  1. テーマのボイラープレートをダウンロードします。

  2. Website\App_Config\Include\z.Feature.Overridesに移動し、z.SPE.Sync.Enabler.Gulp.config.disabled ファイルを有効にします。

  3. ダウンロードしたテーマの定型フォルダーに切り替えます。

  4. sxa init を実行します。

  5. Gulp タスクの設定ファイルを更新します。

    ThemeRoot/gulp/config.js に移動して serverOptions.server に Sitecore インスタンスへのパスを入力します。

  6. Creative Exchange を使用している場合は、このステップをスキップします。

    ThemeRoot/gulp/serverConfig.json を開き、以下を入力します。

    • serverOptions.projectPath - テーマが配置されているプロジェクトへのパス。

    • serverOptions.themePath- プロジェクト ルートからベース テーマ フォルダーへのパス。

  7. コマンド ラインでテーマのルート フォルダーを開きます。

  8. npm i を実行します。

  9. 新しいテーマが利用可能になりました。必ず新しいテーマをサイトに割り当ててください。

    Sitecore/コンテンツ/<tenant>/<site>/設定 に移動して、[サイト設定] セクションの "互換テーマ" フィールドで、新しいテーマを "選択済み" フィールドに追加します。これで、このテーマをサイトの現在のテーマとして選択できます。

次の表は、テーマ設定で SXA CLI を使用するための最も重要なコマンドを示しています。

コマンド

エイリアス

説明

sxa init

sxa i

Creative Exchange Live Mode との互換性のために必要なすべてのファイルをダウンロードします。このプロセスは、不足しているファイルをダウンロードするもので、既存のファイルを置き換えるものではありません。

sxa new <ThemeName> --url <url>

sxa n

テーマの作成パイプラインを実行し、ローカルと Sitecore の両方にテーマを保存します。このコマンドを使用して、サイトの新しいテーマを作成します。

テーマの作成先のインスタンスにテーマを追加できます。現在登録されている Sitecore インスタンスにテーマを作成する場合、URL を指定する必要はありません。

sxa config

sxa c

一連の質問に答えることで、テーマ変数を設定します。テーマの設定を変更するには、このコマンドを使用します。

sxa register <url>

sxa reg

Sitecore URL のインスタンスをグローバルに登録します。

sxa get-url

sxa g

現在登録されている URL を確認します。

sxa build [taskName]

sxa b

現在のテーマ設定に基づいてテーマ アセットを構築します。利用可能なタスクについては、「SXA の監視、構築、アップロードのタスク」を参照してください。

sxa upload [taskName]

sxa u

テーマ設定に基づいて、テーマのアセットをアップロードします。利用可能なタスクについては、「SXA の監視、構築、アップロードのタスク」を参照してください。

sxa watch [taskName]

sxa w

テーマ アセットの変更を監視し、変更されたファイルを自動的にアップロードします。利用可能なタスクについては、「 SXAの監視、構築、アップロードのタスク」を参照してください。

sxa config コマンドで設定できます。

sxa rebuild [taskName]

sxa r

テーマ アセットを再構築してアップロードします。利用可能なタスクについては、以下を参照してください。

SXAの監視、構築、アップロードのタスク

Do you have some feedback for us?

If you have suggestions for improving this article,