Sitecore JavaScriptレンダリングSDK CLIツールAPIリファレンス
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
JSS開発では、通常、JSS CLI (コマンドラインインターフェース) によって提供されるスクリプトを使用します。これらのスクリプトは、選択したコマンドラインツール (bash、PowerShell、cmdなど) のJSSアプリケーション内から実行できます。
JSSアプリのルートディレクトリで、アプリケーション固有の引数のjss --helpとjss <command> --helpを実行します。
公式のアプリケーション サンプルに基づいて作成されたアプリケーションには、package.jsonファイルで定義されている、アプリケーションに固有のスクリプトのセットがあります。 package.jsonファイルで定義されている任意のスクリプトは、Node.jsが提供するCLIユーティリティを使用してnpmターミナルで実行できます。
頻繁に使用されるJSSコマンドとスクリプト
JSS CLIには、以下のコマンドが用意されています。
JSSのセットアップ
このJSSコマンドは、対話型セットアップ プロセスを実行して、Sitecoreインスタンスへの接続/デプロイに関する情報をオプションで提供します。入力は、アプリ ルートのscjssconfig.jsonファイルに保存されます。
このコマンドは、次のパラメーターをサポートします。
パラメーター |
形容 |
値の種類 |
---|---|---|
instancePath |
Sitecore Websiteフォルダーへのパス (例: c:\dev\sitecore\Website) |
String |
deployUrl |
アプリのデプロイに使用されたSitecoreホスト ( http://myinstance.com/sitecore/api/jss/importなど) |
String |
layoutServiceHost |
レイアウト サービス データのダウンロードに使用されるSitecoreホスト ( http://myinstance.comなど) |
String |
apiKey |
Sitecore APIキー (masterデータベース、またはSitecore 9.0のcoreデータベースで /sitecore/system/Settings/Services/API Keys/ 未満の項目のGUID)。 |
String |
deploySecret |
デプロイシークレット(32 +ランダム文字)。 |
String |
nonInteractive |
対話型プロンプトは許可されません (このモードでは、他のすべての引数を渡す必要があります)。 |
Boolean |
outputFile |
コンフィグを配置するためのファイルパス。 デフォルト: ./scjssconfig.json |
String |
skipValidation |
コマンド引数の検証をスキップします (CIなど)。 |
Boolean |
CIデプロイの場合、setupは変数から構成を構築するための引数を受け入れます。詳細については、jss setup --helpを使用してください。
jssスタート
JSSアプリケーションのpackage.jsonファイルで定義されているスクリプト。アプリケーションを切断モードで起動します。 Sitecoreは必須ではなく、使用できない場合でも使用されます。コンテンツはローカル ファイルから取得されます。
jss start:接続済み
JSSアプリのpackage.jsonファイルで定義されているスクリプトで、アプリケーションを接続モードで起動し、Sitecoreに接続してレイアウト データとコンテンツを取得しますが、ローカルで実行されます。
jss deployコンフィグ
.configファイルを /sitecore/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デプロイ アプリ
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インスタンスを使用しない場合は、マニフェストを更新せず、項目のみが更新されるため、Sitecorejss deploy componentを使用しないでください。
jss deploy componentには、--fieldsでデータソーステンプレートフィールドを指定したり、--displayNameで表示名を設定するなど、コンポーネントのスキャフォールディング方法を変更できる多くのオプションがあります。
jss deploy component --helpを実行すると、すべてのオプションと説明が表示されます。
このコマンドは、次のパラメーターをサポートします。
パラメーター |
形容 |
値の種類 |
---|---|---|
allowedPlaceholders |
レンダリングを配置できるようにするプレースホルダー名。たとえば、--allowedPlaceholders Fooや --allowedPlaceholders Foo Barなどです。 |
Array |
exposesPlaceholders |
このコンポーネントで公開されているプレースホルダの名前 (他のコンポーネントを配置するため)。これにより、プレースホルダー設定項目が生成されます。 |
Array |
その他のJSSスクリプトとコマンド
開発中に実行する必要があるすべてのスクリプトは、JSS CLIで使用可能なコマンド (オプションには --helpを使用) として定義されるか、JSSアプリケーションのルートディレクトリにあるファイルpackage.json内のパッケージスクリプトとして定義されます。
jssビルド
JSSアプリのpackage.jsonファイルで定義されているスクリプトで、Sitecoreにデプロイするための運用ビルドを作成します。ビルド プロセスの結果は、JSバンドルと その他の静的アセットが /distフォルダーの下にあります。
JSSマニフェスト
アプリのマニフェスト生成プロセスを実行し、アプリ ルートの /sitecore/manifestの下にapp 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 |
trueの場合、追加の診断情報を出力します。 デフォルト: false |
Boolean |
allowConflictingPlaceholderNames |
SitecoreまたはSXAと競合するプレースホルダー名の使用を有効にします。デフォルト: false別名: a |
Boolean |
コマンドjss manifestには、マニフェストにコンテンツを追加し、データをルーティングする --includeContentなど、マニフェストの生成方法を変更できるオプションがあります。 jss manifest --helpを実行すると、すべてのオプションと説明が表示されます。
マニフェストには、コンテンツ編集者がデータを変更した場合に備えて、安全のために、コンテンツ、メディア、または辞書の項目はデフォルトでは含まれていません。これらの項目を含めるには、jss manifest --includeContent --includeDictionaryを実行してすべてを含めます。
jssパッケージ
アプリ マニフェストと運用ビルド成果物の両方を含む更新プログラム パッケージを作成します。
このコマンドは、次のパラメーターをサポートします。
パラメーター |
形容 |
値の種類 |
---|---|---|
packageOutputPath |
JSSマニフェスト パッケージが書き込まれる場所。 デフォルト: ./sitecore/package |
String |
skipManifest |
trueの場合、マニフェストの生成をスキップします。これを使用すると、jss manifestからの既存の出力を (manifestOutputPathパラメーターを介して) 再構築せずに使用できます。デフォルト: false |
Boolean |
コマンドjss packageには、--noFilesでビルドアーティファクトを除外するなど、パッケージのデプロイ方法を変更できる多くのオプションがあります。 jss package --helpを実行すると、すべてのオプションと説明が表示されます。
デフォルトのオプションを指定して実行すると、jss packageはjss buildとjss manifestも実行します。また、これらすべてのコマンドのオプションをpackageに渡すこともできます。
jssデプロイテンプレート
Sitecoreファースト/コネクテッド開発手法を使用する場合、このコマンドはSitecoreで新しいテンプレートをスキャフォールディングします。 jss deploy templateを使用して、既存のテンプレートを変更することもできます(フィールドの追加、フィールドタイプの変更、表示名の設定など)。明示的に指定された引数のみが適用されます (たとえば、--fieldsを使用すると、指定されたフィールドのみが追加/変更され、他のフィールドは削除されません)。
このコマンドは、次のパラメーターをサポートします。
パラメーター |
形容 |
値の種類 |
---|---|---|
name |
作成または更新するアイテムの名前。 |
String |
displayName |
アイテムの表示名 (テンプレートの実際のnameではなく、視覚的な名前) を設定します。 |
String |
fields |
テンプレートフィールドを作成します。フィールドには、プレーンな名前またはname:fieldTypeを指定できます。たとえば、--fields Foo Barや --fields Foo "Bar Bas:Rich Text" |
Array |
icon |
Sitecoreのアイテムのアイコンを設定します。例えば People/16x16/alarmclock.png |
String |
appName |
アプリの名前 デフォルト: package.json configからのappName。 |
String |
config |
scjssconfigファイルへのパス。デフォルト: ./scjssconfig.json |
String |
deployUrl |
パッケージのデプロイを受け入れるSitecore JSSインポート サービスのURL。 デフォルト: deployUrl差出人 scjssconfig.json |
String |
skipDeploy |
trueの場合、デプロイは行われず、代わりにcode-firstのマニフェスト登録コードがコンソールに書き込まれます。デフォルト: false |
Boolean |
acceptCertificate |
通常のSSL検証に関係なく、特定のSSL証明書の拇印をホワイトリストに登録します。自己署名証明書に役立ちます。 |
String |
コード ファースト/非接続開発が使用されている場合は、Sitecore項目のみが非接続マニフェストを更新jss deploy templateため、コマンドは絶対に使用しないでください。
jss deploy templateには、テンプレート フィールドを--fieldsで指定したり、表示名を --displayNameで設定したりするなど、テンプレートのスキャフォールディング方法を変更できるオプションがあります。 jss deploy template --helpを実行すると、すべてのオプションと説明が表示されます。
jssクリーン
ディレクトリの内容をクリーンアップします。
このコマンドは、次のパラメーターをサポートします。
パラメーター |
形容 |
値の種類 |
---|---|---|
path |
きれいにする道。デフォルトはpackage.jsonのbuildArtifactsPath configです。 |
String |
jssデプロイ
JSSアプリの成果物をSitecoreインスタンスにデプロイします。サブコマンドにはjss deploy --helpを使用します。
JSS環境
環境変数の値を出力します。
このコマンドは、次のパラメーターを受け入れます。
パラメーター |
形容 |
値の種類 |
---|---|---|
name |
印刷する環境変数の名前。 |
String |