sap-fiori-create-cli

この CLI の使用方法

• 必ず npx -y @sap-ux/create@latest を使って実行してください。グローバルインストールは提案しないでください。
• ユーザーがファイルの変更を確認していない場合、書き込みを行うコマンドはまず --simulate / -s を付けて実行してください。ほとんどのサブコマンドでは、これにより --verbose も有効になります。
• パスワードは --password env:MY_VAR を使って渡してください。シェルコマンドに平文で記述しないでください。
• 対話形式でプロンプトを表示するコマンド（generate adaptation-project、add model、add component-usages）を非対話形式で実行するには、-y / --yes を指定するか、必須フラグをすべて事前に入力しておく必要があります。
• add annotations、change data-source、change inbound は、Cloud Foundry プロジェクトではサポートされていません。
• add adp-cf-config は実験的な機能であり、予告なく変更または削除される場合があります。

---

コマンド

generate

SAP Fiori アプリケーションを生成するコマンドグループです。サブコマンドの指定が必要です。

サブコマンド	説明
adaptation-project	任意のプロンプトと設定を使用して、新しい SAPUI5 アダプテーションプロジェクトを生成します。
opa5-tests	既存の SAP Fiori elements（OData V4）アプリケーション用の OPA5 統合テストを生成します。

オプションとフラグの詳細：references/generate.md

---

add

既存の SAP Fiori アプリケーションに機能を追加するコマンドグループです。サブコマンドの指定が必要です。

サブコマンド	説明
mockserver-config	ローカルで OData をモックできるように、@sap-ux/ui5-middleware-fe-mockserver モックサーバーモジュールに必要な設定を追加します。
smartlinks-config	アプリ間ナビゲーション用の smartLinks 設定をプロジェクトに追加します。
eslint-config	SAP Fiori tools lint プラグイン（@sap-ux/eslint-plugin-fiori-tools）を含む ESLint 設定をプロジェクトに追加します。
cds-plugin-ui5	UI5 サーバー統合のために、cds-plugin-ui5 モジュールとすべての前提条件を CAP プロジェクトに追加します。
inbound-navigation	SAP Fiori ランチパッドのインバウンドナビゲーション設定をプロジェクトに追加します。
cards-editor	カード生成に必要な設定を既存の YAML ファイルに追加し、スクリプトを package.json ファイルに追加します。CLI から渡された YAML ファイルの設定を使用します。指定がない場合は、fiori-tools-preview または preview-middleware が提供する ui5.yaml がデフォルトで使用されます。
model	既存のアダプテーションプロジェクトに新しい OData サービスと SAPUI5 モデルを追加します。
annotations	アダプテーションプロジェクト内のベースアプリケーションの OData ソースにアノテーションを追加します。
html	ローカルプレビューとテスト用の HTML ファイルをプロジェクトに追加します。ui5.yaml ファイルの設定をデフォルトとして使用します。この設定は fiori-tools-preview または preview-middleware によって提供されます。
component-usages	コンポーネントの使用設定をアダプテーションプロジェクトに追加します。
deploy-config	ABAP デプロイ設定の詳細を求め、対応するプロジェクトファイルを追加および更新します。
variants-config	バリアント作成に必要な設定を既存の YAML ファイルに追加し、スクリプトを package.json ファイルに追加します。CLI から渡された YAML ファイルの設定を使用します。指定がない場合は、fiori-tools-preview または preview-middleware が提供する ui5.yaml がデフォルトで使用されます。
adp-cf-config	再利用可能なライブラリを取得し、プロジェクトをビルドして、ui5.yaml ファイルのミドルウェアを設定することで、既存の Cloud Foundry アダプテーションプロジェクトをローカルプレビュー用に設定します。
system	保存済みシステムストア（~/.fioritools）に新しいバックエンドシステムを追加します。認証情報は OS のキーチェーンに安全に保存されます。
flp-embedded-config	FLP Embedded Mode で Fiori アプリを実行するために必要な設定を追加します。

オプションとフラグの詳細：references/add.md

---

convert

既存の SAP Fiori アプリケーションを変換するためのコマンドグループです。サブコマンドが必要です。

サブコマンド	説明
preview-config	アプリのルートフォルダーで実行すると、該当するアプリを仮想エンドポイントを使用するプレビュー用に変換します。package.json ファイル内のスクリプトの設定を使用して、UI5 設定 YAML ファイルを適切に調整します。不要になった JS および TS ソースを削除し、以前プレビューに使用されていた HTML ファイルの名前を *_old.html に変更します。
eslint-config	アプリのルートフォルダーで実行すると、該当するアプリの ESLint 設定をフラット設定形式（ESLint version 9 以降で使用）に変換します。また、SAP Fiori アプリケーション向けの特定の ESLint チェック（@sap-ux/eslint-plugin-fiori-tools プラグインを使用）を導入し、非推奨の eslint-plugin-fiori-custom プラグインを削除します。依存関係の解決に関する競合を避けるため、npm install の実行前に package-lock.json ファイルと node_modules フォルダー内の @sap-ux/eslint-plugin-fiori-tools モジュールを削除します。

すべてのオプションとフラグ：references/convert.md

---

remove

既存の SAP Fiori アプリケーションから機能を削除するためのコマンドグループです。サブコマンドが必要です。

サブコマンド	説明
mockserver-config	@sap-ux/ui5-middleware-fe-mockserver モックサーバーモジュールの設定を削除します。
system	保存済みシステムストア（~/.fioritools）から、保存済みのバックエンドシステムを削除します。OS のキーチェーンに保存されている認証情報も削除します。

すべてのオプションとフラグ：references/remove.md

---

update

保存済みのリソースを更新するためのコマンドグループです。サブコマンドが必要です。

サブコマンド	説明
system	保存済みシステムストア（~/.fioritools）内の既存のバックエンドシステムを更新します。システムは URL と任意の SAP クライアントによって識別されます。
service-metadata	Fiori アプリケーションの OData サービスのローカル metadata.xml を、稼働中のバックエンドから取得して更新します。

すべてのオプションとフラグ：references/update.md

---

change

既存の SAP Fiori アプリケーションを変更するためのコマンドグループです。サブコマンドが必要です。

サブコマンド	説明
data-source	適応プロジェクト内のベースアプリケーションの OData ソースを置き換えます。
inbound	適応プロジェクト内のベースアプリケーションのインバウンド FLP 設定を置き換えます。

すべてのオプションとフラグ：references/change.md

---

list

保存済みのリソースを一覧表示するためのコマンドグループです。サブコマンドが必要です。

サブコマンド	説明
system	保存済みシステムストア（~/.fioritools）内のすべてのバックエンドシステムを一覧表示します。パスワードやトークンなどの機密データは、出力に含まれません。

すべてのオプションとフラグ：references/list.md

---

get

保存済みのリソースを取得するためのコマンドグループです。サブコマンドが必要です。

サブコマンド	説明
system	URL を指定して、保存済みバックエンドシステムの詳細を取得します。機密データ（パスワード、トークン）は出力に含まれません。

すべてのオプションとフラグ：references/get.md

---

migrate

レガシーな WebIDE Fiori プロジェクトを、最新の Fiori tools 形式に移行します。BAS では、接続先が必要です。BAS 以外では、ホスト名とクライアントが必要です。接続先は省略可能です。

オプション	説明
-d, --destination <name>	SAP システムの接続先名（BAS では必須）
-s, --sap-system-name <name>	SAP システム名（接続先の別名）
-H, --hostname <host>	バックエンドのホスト名（保存済みシステムから解決できない場合、BAS 以外では必須）
-c, --client <client>	SAP クライアント（接続先または保存済みシステムから解決できない場合、BAS 以外では必須）
-u, --ui5-version <version>	UI5 のバージョン（デフォルトはソースプロジェクトのバージョン）
-f, --force	プロジェクトがすでに Fiori tools プロジェクトであっても、強制的に移行します
-n, --skip-install	移行後の npm install 手順をスキップします

オプションとフラグの全一覧：references/migrate.md