プロジェクト作成、スキーマ変更管理、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
npx rayfin dev # 2. Run the frontend dev server
npx rayfin up # 3. Deploy to Microsoft Fabric
ヒント
既存または空のプロジェクトの場合は、npx rayfin initの代わりにnpm createを使って、すでにソースコードや空のディレクトリがあるプロジェクトに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ヘルプ出力から検証されています。
トップレベルのコマンド
この表を使って、適切なコマンドを素早く見つけましょう。
| 命令 | これを使用して、 |
|---|---|
npx rayfin init [directory] |
Rayfinプロジェクトを作成または設定してください。 |
npx rayfin connector |
Fabricデータコネクターの検索、設定、検査、呼び出し。 |
npx rayfin functions init |
Functionsパッケージをスキャフォールド(Skaffold)にしてください。 |
npx rayfin dev |
アプリとFunctionsはローカルで実行してください。 |
npx rayfin init ai-files |
Rayfinエージェントのコンテキストファイルをインストールまたは確認してください。 |
npx rayfin up |
アプリをFabricにデプロイし、リモート展開を管理してください。 |
npx rayfin env |
rayfin/.envからフレームワーク固有の環境ファイルを生成します。 |
npx rayfin login |
Rayfinプラットフォームにサインインしてください。 |
npx 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
コネクタコマンド
connectorコマンドグループは外部Fabricデータソースを管理します。
rayfin connector types
プロジェクトに追加できるコネクタタイプを一覧にしています。
| Option | 説明 |
|---|---|
--json |
コネクタタイプリストをJSONとしてリリースします。 |
-v, --verbose |
能力の詳細を含めてください。 |
rayfin connector search [query]
サインインしたIDがコネクタとして追加できる情報源をFabricで検索します。
| 議論か選択肢か | 説明 |
|---|---|
[query] |
オプションの大文字を区別しないソース名フィルター。 |
--query <text> |
名前付きソース名フィルターで、 [query]よりも優先されます。 |
--type <type> |
カンマ区切られたコネクタタイプ; --workspace-id または --all-workspacesで必須です。 |
--workspace-id <id> |
1つのFabricワークスペースを検索してみてください。 |
--all-workspaces |
そのアイデンティティがアクセスできるすべてのワークスペースを検索してください。 |
-y, --yes |
インタラクティブな追加ハンドオフを自動的に受け入れます。 |
--limit <n> |
表示結果の最大数。 |
--output <interactive\|plain\|json> |
出力フォーマットを選択してください。 |
--json |
結果をJSONとして印刷し、インタラクティブピッカーは省略してください。 |
-v, --verbose |
詳細出力を有効にします。 |
どちらのワークスペースオプションも提供されていない場合、コマンドは現在のプロジェクト展開で記録されたワークスペースを検索します。
rayfin connector add --type <type>
コネクタ宣言を追加し、プロジェクトファイルをスキャフォールドします。
| Option | 説明 |
|---|---|
--type <type> |
必須。 コネクタの種類; rayfin connector types を使ってタイプを一覧にしてください。 |
--name <name> |
コネクター名;省略された項目に由来します。 |
--workspace-id <id> |
Fabric ワークスペース ID。 |
--item-id <id> |
Fabric ITEM ID。 |
--operations <ops> |
許容操作のコンマ区切られた部分集合。 |
-v, --verbose |
詳細出力を有効にします。 |
-y, --yes |
自動的に確認を受け入れます。 |
--json |
JSON出力を出力してください。 |
rayfin connector list
rayfin.ymlで宣言されたコネクターを一覧にしています。
| Option | 説明 |
|---|---|
-v, --verbose |
コネクタのメタデータや機能を含めてください。 |
--json |
JSON出力を出力してください。 |
rayfin connector inspect
変更を加えずに設定済みのコネクタや直接アドレス指定されたFabricソースを検査します。
| Option | 説明 |
|---|---|
--name <name> |
コネクタ名の設定済み。 |
-w, --workspace <name> |
直接検査用のワークスペース名。 |
--workspace-id <id> |
直接検査用のワークスペースIDです。 |
--item <name> |
直接検査用のアイテム名。 |
--item-id <id> |
直接検査用のアイテムIDです。 |
--type <type> |
直接検査用のコネクタタイプ。 |
--url <url> |
セマンティックモデルポータルのURLは、ワークスペースIDとアイテムIDを導出します。 |
--entity <name> |
エンティティまたはテーブルをサンプルとして使います。エンティティを --query で省略してエンティティをリストアップします。 |
--query <path> |
.sql または .dax ファイルを読み取り専用モードで実行する。 |
--rows <n> |
行数制限;サンプルはデフォルトで10行、上限は100です。 |
-v, --verbose |
詳細出力を有効にします。 |
--output <interactive\|plain\|json> |
出力フォーマットを選択してください。 |
--json |
JSON出力を出力してください。 |
--nameは設定済みコネクタ、完全なダイレクトソースセレクター、--urlはセマンティックモデルに使います。
rayfin connector invoke [connector-name] [operation]
設定済みコネクタに対して操作を呼び出します。
| 議論か選択肢か | 説明 |
|---|---|
[connector-name] |
コネクタ名の設定済み。 |
[operation] |
コネクターの動作、例えば executeQuery。 |
--name <name> |
[connector-name]の代替案として名付けられました。 |
--operation <operation> |
[operation]の代替案として名付けられました。 |
--input <json> |
JSON操作入力。 |
--file <path> |
操作入力を含むJSONファイル。 |
--transport <auto\|deployed> |
召喚パス;デフォルトは autoです。 |
-v, --verbose |
詳細出力を有効にします。 |
--output <interactive\|plain\|json> |
出力フォーマットを選択してください。 |
--output-file <path> |
完全な結果をファイルに書き込む。 |
--max-inline-bytes <bytes> |
ファイル書き込みの結果サイズの閾値;デフォルトは1 MiBです。 |
--json |
JSON出力を出力してください。 |
rayfin connector remove <name>
コネクタ宣言と生成されたコネクタファイルを削除します。
| 議論か選択肢か | 説明 |
|---|---|
<name> |
必須。 コネクターの名前を取り外してください。 |
-v, --verbose |
詳細出力を有効にします。 |
-y, --yes |
削除確認を自動的に受け入れてください。 |
--json |
JSON出力を出力してください。 |
関数コマンド
rayfin functions init [directory]
Functionsパッケージをスキャフォールドし、設定します。
| 議論か選択肢か | 説明 |
|---|---|
[directory] |
Project root;デフォルトは現在のディレクトリです。 |
--force |
既存の関数スキャフォールドを上書きします。 |
--path <relative-path> |
関数パッケージの位置はプロジェクトのルートに対して相対的に扱われます。 |
パッケージの場所はデフォルトで検出されたワークスペースの場所または rayfin/functionsとなります。
開発コマンド
rayfin dev [project-path]
Rayfinのバックエンドに対してローカル開発セッションを開始します。
| 議論か選択肢か | 説明 |
|---|---|
[project-path] |
Project root;デフォルトは現在のディレクトリです。 |
--skip-db-apply |
自動データベース設定はスキップしてください。 |
--env-file <path> |
.env
rayfin.yml補間に使用されたファイル。 |
--provider <fabric> |
バックエンドプロバイダー;デフォルトは fabricです。 |
-w, --workspace <name> |
Fabric ワークスペースは、ファーストランバックエンドの名称です。 |
--workspace-id <id> |
初回実行のバックエンド用のFabricワークスペースIDです。 |
--capacity-id <id> |
使用可能容量のないワークスペースのFabric容量ID。 |
-t, --tenant <id> |
Microsoft Entra テナント ID。 |
--encryption-fallback-enabled |
OSキーチェーンが利用できない場合でも、プレーンテキストトークン保存を許可します。 |
--no-emit-env |
フレームワーク .env.local ファイルを再生成しないでください。 |
-v, --verbose |
詳細ログを有効にします。 |
rayfin dev functions apply
アクティブな展開に対してローカルファンクションホストを起動します。
| Option | 説明 |
|---|---|
--port <port> |
ローカル機能ホストポート;デフォルトは 7071。 |
--inspect-port <port> |
Node.js インスペクターポート;デフォルトは 9229です。 |
--no-debug |
Node.js 検査官を無効にしてください。 |
--no-emit-env |
フレームワーク .env.local ファイルを再生成しないでください。 |
--verbose |
診断出力を表示してください。 |
--json |
JSON出力を出力してください。 |
-y, --yes |
インタラクティブなプロンプトなしで実行してください。 |
エージェントファイルの管理
rayfin init ai-filesコマンドは、プロジェクト内のRayfinエージェントコンテキストファイル(AGENTS.md、.mcp.json、.agents/skills/rayfin/SKILL.md)を管理します。 CLIはプロジェクトをスキャフォールドする際にこれらのファイルを自動でインストールします。 以下のコマンドを実行して、既存のプロジェクトにインストールまたは更新、またはステータスを確認することができます。
rayfin init ai-files install
Rayfinエージェントファイルのインストールまたは更新を行います。 このコマンドは冪等であり、既存のユーザー設定を保持します。
| Option | 説明 |
|---|---|
--enable <id> |
特定のアイテムを名前スペースID(例: skill:rayfin)でインストールまたは保持してください。 再現。 |
--disable <id> |
特定のアイテムの管理をやめてファイルを削除しません。 再現。 |
--remove-files |
アイテムを無効にする際はディスク上のファイルを削除してください。
--disable が必要です。 |
--force [ids...] |
修正されたアイテムを上書きしたり、欠落したアイテムを復元したり、 .mcp.jsonの形を変えたりできます。 操作の範囲をカバーするためにオプションの名前スペースIDを受け入れます。
AGENTS.mdを上書きしない。 |
-n, --dry-run |
ファイルを書かずに変更を報告してください。 |
--json |
構造化出力をJSONとして出力します。これは非インタラクティブモードを含意します。 |
-y, --yes、--non-interactive |
インタラクティブプロンプトをスキップしてデフォルトを受け入れてください。 |
例えば、プロンプトなしでインストールデフォルトを設定する場合:
npx rayfin init ai-files install --yes
rayfin init ai-files status
各マネージドエージェントファイルの状態を印刷します。 構造化出力には --json を使いましょう。
可能な状態には、 up-to-date、 update-available、 user-modified、 missing、 not-installed、 disabled、 orphaned、 unreadableなどがあります。
rayfin init ai-files installを実行してファイルを更新したり、rayfin init ai-files install --force <id>で特定の管理項目を上書きしたりできます。
Fabricにデプロイする
rayfin up
rayfin upを使って、アプリケーションをRayfinアイテムとしてFabricにデプロイしてください。
| Argument | 説明 |
|---|---|
-t, --tenant <id> |
特定のテナントIDを使いましょう。 |
-w, --workspace <name> |
名前でFabricワークスペースにデプロイします。デフォルトはMy Workspaceです。 |
--workspace-id <id> |
特定のFabricワークスペースIDにデプロイします。 |
--workspace-uri <uri> |
特定のFabricワークスペースURIにデプロイします。 |
--item-name <name> |
Fabric アイテムの表示名;デフォルトはプロジェクトIDです。 |
--capacity-id <id> |
ターゲットワークスペースが容量を必要とするときに Fabric 容量 ID。 |
--force |
破壊的なデータスキーマの変更を許可する。 |
-n, --dry-run |
入力を検証し、デプロイせずにワークスペースを解決します。 |
--env-file <path> |
.env デプロイメントプロパティのためにファイル;デフォルトは rayfin/.envです。 |
-v, --verbose |
詳細出力を有効にします。 |
--json |
デプロイメント出力をJSON形式で返します。 |
-y, --yes |
自動的に確認を受け入れます。 |
--encryption-fallback-enabled |
OSキーチェーンが利用できない場合でも、プレーンテキストトークン保存を許可します。 |
--exclude-services <names> |
ビルドおよび展開時にスキップするコンマ区切られたサービス: staticHosting または functions。 |
--provider <fabric> |
デプロイメントプロバイダー;デフォルトは fabricです。 |
Examples
現在選択されているFabricワークスペースにデプロイ:
npx rayfin up
適用せずにデプロイアクションをプレビューする:
npx rayfin up --dry-run --verbose
特定のワークスペースに非インタラクティブにデプロイする:
npx rayfin up --workspace-id <workspace-id> --yes
機能を構築または展開せずに展開する:
npx rayfin up --exclude-services functions
--capacity-id
--workspace、--workspace-id、--workspace-uri と組み合わせることはできません。
| サブコマンド | 説明 |
|---|---|
npx rayfin up db apply |
リモートのRayfin項目ワークロードエンドポイントにDAB設定を生成し適用します。 |
npx rayfin up functions deploy |
アクティブなリモートアイテムに関数をビルド、パッケージ化、デプロイします。 |
npx rayfin up staticapp deploy |
静的コンテンツをリモートのRayfinアイテムにビルド、パッケージ化、デプロイします。 |
npx rayfin up connector apply |
宣言済みのGraphQLコネクタにデータベース設定を適用します。 |
npx rayfin up status |
現在の展開状況を表示してください。 |
npx rayfin up list |
プロジェクトで記録されたすべてのFabricデプロイメントをリストアップしてください。 |
npx 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 functions deploy
Functionsをビルド、パッケージ化、デプロイします。
| Option | 説明 |
|---|---|
--verbose |
詳細出力を表示します。 |
--skip-build |
既存の関数出力をビルドせずにデプロイします。 |
--json |
JSON出力を出力してください。 |
rayfin up connector apply
宣言されたGraphQLコネクターのデータベース構成を適用します。
| Option | 説明 |
|---|---|
--name <name> |
名前付きのコネクターだけを適用してください。 |
--verbose |
詳細出力を有効にします。 |
--json |
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を使って、.env.localからフレームワーク固有のrayfin/.env値を出力してください。
| 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
| サブコマンド | 説明 |
|---|---|
npx rayfin login status |
現在の認証状況を表示します。 |
rayfin login status
現在の認証状況を表示します。
| Argument | 説明 |
|---|---|
| なし | このサブコマンドにはCLIのヘルプ出力にオプションが記載されていません。 |
例
サインインしているか確認してください:
npx rayfin login status
rayfin logout
サインインしてキャッシュされた認証情報を消去します。
| Argument | 説明 |
|---|---|
| なし | このコマンドはCLIのヘルプ出力にオプションを表示していません。 |
例
ログアウトしてキャッシュした認証情報をクリアする:
npx rayfin logout