Rayfin CLI リファレンス

プロジェクト作成、スキーマ変更管理、Fabricへのデプロイ、環境設定の設定のためのRayfinのCLIコマンドを見つけてください。 各セクションにはコマンド構文、オプション、一般的な用途が記載されています。

Installation

npm i @microsoft/rayfin-cliを使ってCLIをインストールしてください。

作業の開始

端末の手順に従ってFabricアプリを作成しましょう。

npm create @microsoft/rayfin@latest my-app  # 1. Create a project from a template
cd my-app
npm run dev     # 2. Run the frontend dev server
npx rayfin up   # 3. Deploy to Microsoft Fabric

ヒント

既存または空のプロジェクトの場合は、npm createの代わりにnpx rayfin initを使って、すでにソースコードや空のディレクトリがあるプロジェクトにRayfinを追加してください。 initコマンドは、サービスの有効化、データベース方言の選択、新しいテンプレートをスキャフォールドせずに静的ホスティングの設定を案内します。

全体の解説については、CLIで最初のFabricアプリを作成・デプロイする」と「Deploy a Fabric appをFabricにデプロイする」をご覧ください。

スキャフォールド プロジェクト npm create

npm create ( npm initの別名)Create initializerパッケージを呼び出して新しいプロジェクトをブートストラップします。 Fabricアプリをスキャフォールドするには、@microsoft/rayfin initializerと組み合わせて使用してください:

npm create @microsoft/rayfin@latest my-app --workspace <workspace name>

コマンド リファレンス

この記事のコマンドとフラグは、ローカルにインストールされたCLIヘルプ出力から検証されています。

トップレベルのコマンド

この表を使って、適切なコマンドを素早く見つけましょう。

命令	これを使用して、
rayfin init [directory]	Rayfinプロジェクトを作成または設定してください。
rayfin up	アプリをFabricにデプロイし、リモート展開を管理してください。
rayfin env	rayfin/.envからフレームワーク固有の環境ファイルを生成します。
rayfin login	Rayfinプラットフォームにサインインしてください。
rayfin logout	ログアウトしてキャッシュ認証情報をクリアしてください。

プロジェクトの作成または設定

rayfin init [directory]

rayfin initを使ってRayfinを新規または既存のプロジェクトに追加してください。

Argument	説明
--project-name <name>	プロジェクト名を設定します。
-t, --template <uri>	使用するテンプレートURIを指定します。
--template-name <name>	テンプレートを名前で選びます。
-l, --list-templates	利用可能なテンプレートをリストアップしましょう。
--dialect <dialect>	データベースの方言を設定してください。
--services <list>	どのサービスを有効にするか選びましょう。
--auth-methods <list>	認証方法を選択します。
--static-hosting	静的ホスティングの設定を有効にしてください。
--overwrite	既存の生成ファイルを上書きしてください。
--workspace-id <id>	特定のFabricワークスペースIDを使ってください。
--workspace-uri <uri>	特定のFabricワークスペースURIを使ってください。
--base-api-url <url>	基本のAPI URLを上書きしてください。
--item-id <id>	特定のFabricアイテムIDをターゲットにしてください。

Examples

足場の前に利用可能なテンプレートをリストアップする:

npx rayfin init --list-templates

現在のディレクトリでRayfinを初期化するには、名前付きテンプレートと特定の方言を使いましょう:

npx rayfin init . --template-name react-vite --dialect mssql

サービスと認証を設定した非対話型の新しいプロジェクトを作成する:

npx rayfin init my-app --project-name my-app --services db,storage --auth-methods fabric --static-hosting --overwrite

Fabricにデプロイする

rayfin up

rayfin upを使って、アプリケーションをRayfinアイテムとしてFabricにデプロイしてください。

Argument	説明
--tenant <id>	特定のテナントIDを使いましょう。
--workspace-id <id>	特定のFabricワークスペースIDにデプロイします。
--workspace-uri <uri>	特定のFabricワークスペースURIにデプロイします。
--base-api-url <url>	基本のAPI URLを上書きしてください。
--force	必要に応じて部隊展開のステップを踏みます。
--dry-run	デプロイアクションを適用せずにプレビューできます。
--env-file <path>	ファイルから環境値を読み込みます。
--verbose	詳細な展開出力を表示します。
--json	デプロイメント出力をJSON形式で返します。
-y, --yes	プロンプトを自動的に受け入れます。
--encryption-fallback-enabled	暗号化のフォールバック動作を有効にしてください。

Examples

現在選択されているFabricワークスペースにデプロイ:

npx rayfin up

適用せずにデプロイアクションをプレビューする:

npx rayfin up --dry-run --verbose

特定のワークスペースに非インタラクティブにデプロイする:

npx rayfin up --workspace-id 00000000-0000-0000-0000-000000000000 --yes

サブコマンド	説明
rayfin up db apply	リモートのRayfin項目ワークロードエンドポイントにDAB設定を生成し適用します。
rayfin up staticapp deploy	静的コンテンツをリモートのRayfinアイテムにビルド、パッケージ化、デプロイします。
rayfin up status	現在の展開状況を表示してください。
rayfin up list	プロジェクトで記録されたすべてのFabricデプロイメントをリストアップしてください。
rayfin up switch [workspace]	アクティブFabric展開を切り替え、rayfin/.envを書き換えます。

rayfin up db apply

リモートのRayfin項目ワークロードエンドポイントにDAB設定を生成し適用します。

Argument	説明
--verbose	詳細出力を表示します。
--force	強制再生を施し、設定を適用します。
--json	出力をJSON形式で返します。

Examples

リモートのRayfinアイテムにデータベース設定の変更を適用する:

npx rayfin up db apply

強制再生と機械可読出力のキャプチャ:

npx rayfin up db apply --force --json

rayfin up staticapp deploy

静的コンテンツをリモートのRayfinアイテムにビルド、パッケージ化、デプロイします。

Argument	説明
--verbose	詳細出力を表示します。
--skip-build	ビルドステップを実行せずにデプロイしてください。
--json	出力をJSON形式で返します。

Examples

静的コンテンツの構築と展開:

npx rayfin up staticapp deploy

ビルドをやり直さずにプリビルド dist フォルダをデプロイする:

npx rayfin up staticapp deploy --skip-build

rayfin up status

クラウド展開の状況を表示します。

Argument	説明
--json	JSON形式の返送ステータス。
--verbose	詳細出力を表示します。

Examples

現在の展開状況を確認してください:

npx rayfin up status

スクリプトで使用するためのJSONステータスを返す:

npx rayfin up status --json

rayfin up list

このプロジェクトで記録されたすべてのFabricデプロイメントを一覧にしています。

Argument	説明
--json	デプロイメントリストをJSON形式で返してください。

Examples

プロジェクトで記録されたすべてのFabric展開をリストアップします:

npx rayfin up list

rayfin up switch [workspace]

アクティブFabric展開を切り替え、rayfin/.envを適切に書き換えます。

Argument	説明
-l, --list	切り替えなしで利用可能な展開をリストアップしてください。
--no-emit-env	エミットされた環境ファイルの書き込みは省略してください。

Examples

切り替え可能な展開一覧:

npx rayfin up switch --list

アクティブ展開を特定のワークスペースに切り替える:

npx rayfin up switch my-workspace

環境ファイルの生成

rayfin env

rayfin envを使って、rayfin/.envからフレームワーク固有の.env.local値を出力してください。

Argument	説明
--framework <vite|nextjs|plain>	ターゲットフレームワークのフォーマットを選びます。
--output <dir>	生成されたファイルを特定のディレクトリに書き込む。
--show	ファイルを書き込まずに出力した値を印刷できます。

Examples

Vite互換 .env.localを生成する:

npx rayfin env --framework vite

ファイルを書き込まずにエミットされた環境値をプレビュー:

npx rayfin env --framework nextjs --show

サインインとサインアウト

rayfin login

rayfin loginを使ってRayfinプラットフォームにサインインしてください。

Argument	説明
--tenant <id>	特定のテナントIDを使いましょう。
--service-principal	サービス担当のサインインを試みてください。 このオプションはヘルプに記載されていますが、現在はサポートされていません。
-u, --client-id <id>	サービスプリンシパルのサインインにはクライアントIDを提供してください。 このオプションはヘルプに記載されていますが、現在はサポートされていません。
-p, --client-secret <secret>	サービスプリンシパルサインイン用のクライアントシークレットを提供します。 このオプションはヘルプに記載されていますが、現在はサポートされていません。
--select	利用可能なサインイン済みアカウントやコンテキストから選択してください。
--encryption-fallback-enabled	暗号化のフォールバック動作を有効にしてください。

Examples

インタラクティブにサインイン:

npx rayfin login

特定のテナントにサインイン:

npx rayfin login --tenant 00000000-0000-0000-0000-000000000000

サインイン済みアカウント間の切り替え:

npx rayfin login --select

サブコマンド	説明
rayfin login status	現在の認証状況を表示します。

rayfin login status

現在の認証状況を表示します。

Argument	説明
なし	このサブコマンドにはCLIのヘルプ出力にオプションが記載されていません。

例

サインインしているか確認してください:

npx rayfin login status

rayfin logout

サインインしてキャッシュされた認証情報を消去します。

Argument	説明
なし	このコマンドはCLIのヘルプ出力にオプションを表示していません。

例

ログアウトしてキャッシュした認証情報をクリアする:

npx rayfin logout