Sitecore JavaScript CLIツールSDKレンダリングAPI参照

jss Create

JSSアプリケーションを作成します。アプリケーション名とフレームワークを提供する必要があります。

jss create

このコマンドには以下のパラメータが必要です:

パラメータ

概要

価値タイプ

name

作成するアプリの名前。

String

template

アプリを作成するためのテンプレートは;公式JSSリポジトリ内のフォルダに対応します

String

このコマンドは以下のオプションパラメータをサポートしています:

パラメータ

概要

オプション

デフォルト

テンプレート

--version

番組バージョン番号

-

true

全員

--help

コマンドに助けを求めてください

-

true

全員

--hostName, -r

このアプリがSitecoreに展開されている場合、Sitecoreサイトのホスト名を設定します。

-

$name.dev.local

全員

--repository, -r

JSSアプリを作成するためにリポジトリを設定する

リポジトリ: /

Sitecore/jss

全員

--branch, -b

リポジトリのブランチをJSSアプリ作成に使うように設定します

支店名

master

全員

--source, -s

アプリテンプレートはGitHubリポジトリではなくローカルのファイルシステムパスからソース化します。カスタムJSSアプリテンプレートへの使用

ローカルディレクトリパス

-

全員

--proxy, -p

テンプレートをダウンロードする際にHTTPプロキシを指定します。

ローカルディレクトリパス

-

全員

--fetchWith

アプリケーションがSitecoreのレイアウトおよび辞書データを取得する方法を指定します。

REST または GraphQL

REST

Nextjs、react、angular、vue

--prerender

プライマリ ...path.tsx ルートのNext.jsプリレンダリングフォームを指定します。

SSG または SSR

SSG

Nextjs

--empty

アプリが空で作成されることを指定します

-

false

Nextjs

jssセットアップ

このJSSコマンドはインタラクティブなセットアッププロセスを実行し、オプションでSitecoreインスタンスへの接続やデプロイに関する情報を提供します。入力はアプリのrootにあるscjssconfig.jsonファイルに保存されます。

このコマンドは以下のパラメータをサポートしています:

パラメータ

概要

価値タイプ

instancePath

Sitecore Website フォルダへのパス(例:c:\dev\sitecore\Website)

String

deployUrl

アプリのデプロイに使われたSitecoreホスト(例: http://myinstance.com/sitecore/api/jss/import)

String

layoutServiceHost

レイアウトサービスのデータ(例: http://myinstance.com)をダウンロードするために使用されたSitecoreホスト

String

apiKey

Sitecore APIキー(masterデータベースの*/sitecore/system/Settings/Services/API Keys/*項目のGUID、またはSitecore 9.0のcoreデータベース)。

String

deploySecret

デプロイの秘密(32+ランダムキャラ)。

String

nonInteractive

インタラクティブなプロンプトは禁止されます(このモードでは他のすべての引数を渡す必要があります)。

Boolean

outputFile

設定を配置するためのファイルパス。 デフォルト: ./scjssconfig.json

String

skipValidation

コマンド引数の検証(例えばCIの場合)は省略してください。

Boolean

!注CI展開の場合、setup変数から構成を構築するための引数を受け入れます。詳細はjss setup --helpを参照してください。

JSS START

JSSアプリのpackage.jsonファイルに定義されたスクリプトで、アプリケーションを切断モードで起動させます。Sitecoreは必須ではなく、利用可能でも使われません。コンテンツはローカルファイルから得られます。

jss start

JSSアプリのpackage.jsonファイルに定義されたスクリプトで、アプリケーションを接続モードで起動し、レイアウトデータやコンテンツを取得するためにSitecoreAIに接続しますが、ローカルで動作します。

jss deploy config

/sitecore/config.configファイルをアプリのルートにあるSitecoreインスタンスのWebsite/App_Config/zzzフォルダにコピーscjssconfig.json。これは利便性のためのスクリプトです。JSSアプリの設定を他の方法で手動でデプロイしたり、設定をJSSアプリではなくSitecoreインスタンスに所有させることもできます。

このコマンドは以下のパラメータをサポートしています:

パラメータ

概要

価値タイプ

source

デプロイするための設定パッチのソースパスです。デフォルト: ./sitecore/config

String

destination

展開先のパス。scjssconfig.jsonで設定したinstancePathとpackage.jsonのsitecoreConfigPath設定を組み合わせてデフォルト。

String

config

ファイルへのパス scjssconfig 。デフォルト: ./scjssconfig.json

String

jss deploy app

略してjss deploy items && jss deploy files。アプリのマニフェスト項目(ルート、テンプレートなど)とアプリの本番コードの両方をデプロイするために使われました。

選択肢としてjss deploy app --helpを活用しましょう。

!注コマンドjss deploy app jss deploy itemsまたはjss deploy filesでサポートされているすべての選択肢を受け入れます。

jssデプロイアイテム

このコマンドは、コードファーストのJSS開発手法を使う際に使い、マニフェストを作成し、Sitecoreにアイテムをデプロイしたい場合に使います。

このコマンドは以下のパラメータをサポートしています:

パラメータ

概要

価値タイプ

deployUrl

パッケージ展開を受け入れるSitecore JSSインポートサービスのURLです。**デフォルト:**deployUrlscjssconfig.json

String

deploySecret

Sitecoreでデプロイメントを認証するための共有秘密。**デフォルト:**deploySecretscjssconfig.json

String

config

ファイルへのパス scjssconfig 。デフォルト: ./scjssconfig.json

String

debugSecurity

デプロイメントの認証問題の診断を可能にします。秘密を出力に公開し、一時的な診断のみに使用します。デフォルト: false

Boolean

skipPackage

trueの場合、ビルド、マニフェスト、パッケージングの各ステップをスキップします。これにより、パッケージを再構築せずにjssパッケージの既存出力(packageOutputPathパラメータを介して)を消費できます。デフォルト: false

Boolean

proxy

アイテム展開時に使うHTTPプロキシを指定します。

String

acceptCertificate

通常のSSL検証に関わらず、特定のSSL証明書のサムプリントをホワイトリストに登録します。自己署名証明書に有用です。

String

!注コマンドjss deploy itemsには、--noContentを含むコンテンツ項目を除外するなど、パッケージの展開方法を変更できる多くのオプションがあります。 jss deploy items --helpを実行すると、説明付きのすべてのオプションが表示されます。

デフォルトのオプションで実行すると、jss deploy items jss manifest、およびjss packageも実行されます。これらすべてのコマンドのオプションはdeploy itemsにも渡すことができます。

コンテンツ、メディア、辞書の項目は、コンテンツエディターがデータを変更した場合、安全のためデフォルトで除外されます。これらの項目を展開するには、jss deploy items --includeContent --includeDictionaryを実行してすべてをデプロイしてください。

jssデプロイファイル

本番アプリケーション(jss build)を構築し、すべてのファイルをscjssconfig.jsonのSitecoreインスタンスにコピーします。アイテムはデプロイされず、マニフェストも生成されません。

このコマンドは以下のパラメータをサポートしています:

パラメータ

概要

価値タイプ

source

デプロイするための設定パッチのソースパスです。デフォルト: ./sitecore/config

String

destination

展開先のパス。scjssconfig.jsonで設定したinstancePathとpackage.jsonのsitecoreConfigPath設定を組み合わせてデフォルト。

String

config

ファイルへのパス scjssconfig 。デフォルト: ./scjssconfig.json

String

exclude

デプロイメントパッケージから特定のファイルをファイル名でフィルタリングします。デフォルト: 'report.html'

Array

skipBuild

trueの場合、ビルドタスクは起動されず、ソースパス上の既存のビルドアーティファクトはデプロイされます。デフォルト: false

Boolean

buildTaskName

デプロイ前にビルドを実行するために実行する npm スクリプトの名前。スクリプトを実行しないようにするには、 --skipBuild を使うか、引数を空欄で渡してください。デフォルト: build

String

clean

新しいアーティファクトをコピーする前に、宛先内のすべての既存アイテムを削除するかどうか。デフォルト: false

Boolean

!注コマンドjss deploy filesには、ビルドをスキップしたり既存の /distアイテムを --skipBuildで使ったりと、ファイルのデプロイ方法を変更できる多くのオプションがあります。 jss deploy files --helpを実行すると、すべてのオプションと説明が表示されます。デフォルトオプションで実行すると、jss deploy filesもjss build実行されます。

jssデプロイコンポーネント

Sitecoreファースト/コネクテッド開発手法を使用する場合、このコマンドはSitecore内に新しいコンポーネント(レンダリングアイテム、データソーステンプレート、許可されたプレースホルダー設定)をスキャフォールドします。

開発者はJSSアプリ内でコンポーネントを作成し、Sitecoreエディタのいずれかでルートに追加する必要があります。

コマンドjss deploy componentは、フィールドの追加、フィールドタイプの変更、表示名の設定など、既存のコンポーネントを変更することも可能です。明示的に指定された引数のみが適用されます。例えば、--fieldsパラメータを使用すると指定されたフィールドのみを追加・修正し、他のフィールドは削除されません。

!重要コードファーストやSitecoreインスタンスなしで作業する場合は、マニフェストを更新せずjss deploy componentSitecore項目だけを更新するため、絶対に使ってはいけません。

jss deploy componentコンポーネントのスキャフォールド方法を変更できる多くのオプションがあり、例えばデータソーステンプレートフィールドを--fieldsで指定したり、表示名を--displayNameで設定したりします。

jss deploy component --help走って説明付きの全ての選択肢を見てください。

このコマンドは以下のパラメータをサポートしています:

パラメータ

概要

価値タイプ

allowedPlaceholders

レンダリングを配置するためのプレースホルダー名。例えば --allowedPlaceholders Foo や --allowedPlaceholders Foo Bar。

Array

exposesPlaceholders

このコンポーネントに公開されているプレースホルダーの名前(他のコンポーネントを配置するため)です。これにより、それらのためにプレースホルダー設定項目が生成されます。

Array

jssビルド

JSSアプリのpackage.jsonファイルに定義されたスクリプトで、Sitecoreにデプロイするための本番ビルドを作成します。ビルドプロセスの結果として、/distフォルダーの下にJSバンドルやその他の静的資産が残されます。

jssマニフェスト

アプリのマニフェスト生成プロセスを実行し、アプリルート内で/sitecore/manifestのアプリマニフェストファイルを生成します。

このコマンドは以下のパラメータをサポートしています:

パラメータ

概要

価値タイプ

appName

アプリ名です。デフォルトはpackage.json設定値です。

String

manifestSourceFiles

マニフェストを生成するために解析すべきファイルやファイルパターン。 デフォルト: './sitecore/definitions/**/*.sitecore.js', './sitecore/definitions/**/*.sitecore.ts'

Array

require

マニフェスト処理前に必要とするJSモジュール。これによりカスタムコンパイラ(Babel、TypeScript)を初期化したり、initタスクを実行したりすることがあります。 デフォルト: ./sitecore/definitions/config.js

String

manifestOutputPath

マニフェスト出力が書き込まれるファイルのパス。 デフォルト: ./sitecore/manifest

String

includeContent

マニフェスト出力にコンテンツおよびメディア項目が含まれます。デフォルト:falseエイリアス: c

Boolean

includeDictionary

マニフェスト出力に辞書項目を含める。デフォルト:falseエイリアス: d

Boolean

language

マニフェストが表現する言語を定義します。package.jsonの言語設定をデフォルトで使います。 エイリアス: l

String

rootPlaceholders

アプリのルートプレースホルダー名を設定します。設定すると、package.jsonで設定されたルートプレースホルダーを上書きします。 エイリアス: p

Array

wipe

JSSインポートが既存のアプリ項目のワイプ+再作成として実行されます。CIシナリオではインタラクティブ確認をバイパス--unattendedWipe、パスも可能です。デフォルト:falseエイリアス: w

Boolean

pipelinePatchFiles

パイプラインの設定パッチファイルを読み込むためのファイルやファイルパターンの一覧。 デフォルト: './sitecore/pipelines/**/*.patch.js', './sitecore/pipelines/**/*.patch.ts'

Array

debug

もし正しければ、追加の診断情報を発信します。 デフォルト: false

Boolean

allowConflictingPlaceholderNames

SitecoreやSXAと矛盾するプレースホルダー名の使用を可能にします。デフォルト:falseエイリアス: a

Boolean

!注コマンドjss manifestには、マニフェストの生成方法を変更できるオプションがあり、例えばコンテンツの追加やマニフェストへのルーティング --includeContentなどがあります。 jss manifest --helpを実行すると、すべてのオプションと説明が表示されます。

Manifestは、コンテンツ編集者がデータを変更した場合の安全のため、デフォルトでコンテンツ、メディア、辞書項目を含めません。これらの項目を含めるには、すべてを含めるためにjss manifest --includeContent --includeDictionaryを実行してください。

jssパッケージ

アプリマニフェストと本番ビルドのアーティファクトの両方を含むアップデートパッケージを作成します。

このコマンドは以下のパラメータをサポートしています:

パラメータ

概要

価値タイプ

packageOutputPath

JSSマニフェストパッケージが書き込まれる場所。 デフォルト: ./sitecore/package

String

skipManifest

trueの場合、マニフェスト生成をスキップします。これにより、jss manifestの既存出力(manifestOutputPathパラメータを介して)を再構築せずに消費できます。デフォルト: false

Boolean

!注コマンドjss packageには、ビルドアーティファクトを --noFilesで除外するなど、パッケージの展開方法を変更できる多くのオプションがあります。 jss package --helpを実行すると、すべてのオプションと説明が表示されます。

デフォルトオプションで実行すると、jss packagejss buildとjss manifestも実行されます。これらのコマンドのオプションをすべてpackageに渡すことも可能です。

jssデプロイテンプレート

Sitecore優先/接続開発手法を使用する場合、このコマンドはSitecoreに新しいテンプレートをスキャフォールドします。 jss deploy templateは既存のテンプレートの変更(例

このコマンドは以下のパラメータをサポートしています:

パラメータ

概要

価値タイプ

name

作成または更新するアイテムの名前。

String

displayName

アイテムの表示名(テンプレートの実際の name ではなくビジュアルネーム)を設定します。

String

fields

テンプレートフィールドを作成します。フィールドは単純な名前でも、 name

Array

icon

Sitecoreでアイテムのアイコンを設定します。例えば、 People/16x16/alarmclock.png

String

appName

アプリ名。**デフォルト:**package.json設定からappName。

String

config

ファイルへのパス scjssconfig 。 デフォルト: ./scjssconfig.json

String

deployUrl

パッケージ展開を受け入れるSitecore JSSインポートサービスのURLです。**デフォルト:**deployUrl出自scjssconfig.json

String

skipDeploy

trueの場合、展開は行われず、代わりにコードファーストのマニフェスト登録コードがコンソールに書き込まれます。デフォルト: false

Boolean

acceptCertificate

通常のSSL検証に関わらず、特定のSSL証明書のサムプリントをホワイトリストに登録します。自己署名証明書に有用です。

String

!注コードファースト/切断された開発が使用されている場合、コマンドjss deploy templateは切断されたマニフェストを更新せず、Sitecore項目のみを更新するため、絶対に使用してはいけません。

jss deploy templateテンプレートのスキャフォールドの構成方法を変更できるオプションがあり、例えばテンプレートフィールドを --fieldsで指定したり、表示名を --displayNameで設定したりします。 jss deploy template --helpを実行して、すべてのオプションと説明が表示されます。

JSSクリーン

ディレクトリの内容をクリーンアップします。

このコマンドは以下のパラメータをサポートしています:

パラメータ

概要

価値タイプ

path

クリーンへの道筋。デフォルトはpackage.jsonbuildArtifactsPath設定です。

String

jssデプロイ

JSSアプリのアーティファクトをSitecoreインスタンスにデプロイします。サブコマンドにはjss deploy --helpを使います。

jssデプロイパッケージ

このコマンドは 推奨されていません。代わりにjss deploy appを使いましょう。

JSS環境

環境変数の値を出力します。

コマンドは以下のパラメータを受け入れます:

パラメータ

概要

価値タイプ

name

プリントする環境変数の名前。

String