Referencja Rayfin CLI

Znajdź polecenia Rayfin CLI do tworzenia projektów, zarządzania zmianami schematu, wdrażania do Fabric oraz konfigurowania ustawień środowiska. Każda sekcja zawiera składnię poleceń, opcje i powszechne zastosowania.

Instalacja

Używam do npm i @microsoft/rayfin-cli instalacji CLI.

Rozpoczęcie pracy

Postępuj zgodnie z instrukcjami w terminalu, aby utworzyć aplikację 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

Wskazówka

Dla istniejących lub pustych projektów używaj npx rayfin init zamiast npm create dodania Rayfin do projektu, który już ma kod źródłowy lub pusty katalog. Polecenie init przeprowadza Cię przez proces włączania usług, wyboru dialektu bazy danych oraz konfiguracji statycznego hostingu bez tworzenia nowego szablonu.

Pełny przegląd znajdziesz w Stwórz i wdroż swoją pierwszą aplikację Fabric z CLI oraz Wdroż aplikację Fabric na Fabric.

Rusztowanie projektu z npm create

npm create (pseudonim ) npm init uruchamia nowy projekt, wywołując pakiet inicjalizatora tworzenia. Aby podtrzymać aplikację Fabric, użyj jej z inicjalizatorem @microsoft/rayfin:

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

Referencja poleceń

Polecenia i flagi zawarte w tym artykule zostały zweryfikowane na podstawie lokalnie zainstalowanego pliku pomocy CLI.

Polecenia najwyższego poziomu

Użyj tej tabeli, aby szybko znaleźć właściwe polecenie.

Polecenie	Wykorzystaj ją do
npx rayfin init [directory]	Stwórz lub skonfiguruj projekt Rayfin.
npx rayfin connector	Znajdź, konfiguruj, przeglądaj i wywołuj złącza danych Fabric.
npx rayfin functions init	Konstruuj pakiet Functions.
npx rayfin dev	Uruchom aplikację i funkcje lokalnie.
npx rayfin init ai-files	Zainstaluj lub sprawdź pliki kontekstowe agentów Rayfin.
npx rayfin up	Wdroż aplikację na Fabric i zarządzaj zdalnymi wdrożeniami.
npx rayfin env	Generuj pliki środowiskowe specyficzne dla frameworka z rayfin/.env.
npx rayfin login	Zaloguj się na platformę Rayfin.
npx rayfin logout	Wyloguj się i usuń dane logowania w pamięci podręcznej.

Stwórz lub skonfiguruj projekt

rayfin init [directory]

Używam rayfin init do dodania Rayfin do nowego lub istniejącego projektu.

Argument	Opis
--project-name <name>	Ustaw nazwę projektu.
-t, --template <uri>	Określ szablon URI, którego chcesz użyć.
--template-name <name>	Wybierz szablon według nazwy.
-l, --list-templates	Wypisz dostępne szablony.
--dialect <dialect>	Ustaw dialekt bazy danych.
--services <list>	Wybierz, które usługi włączyć.
--auth-methods <list>	Wybierz metody uwierzytelniania.
--static-hosting	Włącz statyczne ustawienia hostingu.
--overwrite	Nadpisz istniejące wygenerowane pliki.
--workspace-id <id>	Użyj konkretnego identyfikatora Fabric workspace.
--workspace-uri <uri>	Użyj konkretnego URI Fabric workspace.
--base-api-url <url>	Nadpisz bazowy adres URL API.
--item-id <id>	Celuj w konkretny item ID Fabric.

Examples

Przed rusztowaniem wypisz dostępne szablony:

npx rayfin init --list-templates

Zainicjuj Rayfin w aktualnym katalogu, używając szablonu nazwanego i konkretnego dialektu:

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

Stwórz nowy projekt nieinteraktywny z skonfigurowanymi usługami i uwierzytelnianiem:

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

Polecenia łączące

Grupa connector poleceń zarządza zewnętrznymi źródłami danych Fabric.

rayfin connector types

Zawiera listę typów łączników, które możesz dodać do projektu.

Option	Opis
--json	Lista typów złącza jest oznaczona jako JSON.
-v, --verbose	Dołącz szczegóły dotyczące możliwości.

rayfin connector search [query]

Searches Fabric wskazuje, że tożsamość zalogowana może dodać jako łączniki.

Argument lub opcja	Opis
[query]	Opcjonalny, nierozróżniający wielkości liter filtr nazw źródłowych.
--query <text>	Nazwany filtr nazw źródłowych, który ma pierwszeństwo przed [query].
--type <type>	Typy złączy oddzielonych przecinkami; wymagane z lub --workspace-id--all-workspaces.
--workspace-id <id>	Przeszukaj jedno miejsce pracy Fabric.
--all-workspaces	Przeszukaj każdą przestrzeń roboczą, do której tożsamość ma dostęp.
-y, --yes	Automatycznie zaakceptuj interaktywne przekazanie dodatków.
--limit <n>	Maksymalna liczba wyświetlanych wyników.
--output <interactive\|plain\|json>	Wybierz format wyjściowy.
--json	Wydrukuj wyniki jako JSON i pomiń interaktywny picker.
-v, --verbose	Włącz pełne dane wyjściowe.

Gdy żadna z opcji workspace nie jest dostarczona, polecenie przeszukuje workspaces zarejestrowane dla bieżącego wdrożenia projektu.

rayfin connector add --type <type>

Dodaje deklarację łącznika i tworzy rusztowania swoich plików projektowych.

Option	Opis
--type <type>	Required. Typ złącza; używaj rayfin connector types do wymieniania typów.
--name <name>	Nazwa złącza; pochodzi od elementu, gdy jest pomijany.
--workspace-id <id>	Fabric workspace ID.
--item-id <id>	Fabric item ID.
--operations <ops>	Podzbiór dozwolonych operacji oddzielonych przecinkami.
-v, --verbose	Włącz pełne dane wyjściowe.
-y, --yes	Automatycznie przyjmuj potwierdzenia.
--json	Emituj wyjście JSON.

rayfin connector list

Wymienia złącza zadeklarowane w rayfin.yml.

Option	Opis
-v, --verbose	Dołącz metadane i możliwości łączników.
--json	Emituj wyjście JSON.

rayfin connector inspect

Sprawdza skonfigurowane złącze lub bezpośrednio adresowane źródło Fabric bez wprowadzania zmian.

Option	Opis
--name <name>	Skonfigurowana nazwa złącza.
-w, --workspace <name>	Nazwa miejsca pracy do bezpośredniej inspekcji.
--workspace-id <id>	ID miejsca pracy do bezpośredniej inspekcji.
--item <name>	Nazwa przedmiotu do bezpośredniej inspekcji.
--item-id <id>	Numer przedmiotu do bezpośredniej inspekcji.
--type <type>	Typ złącza do bezpośredniej inspekcji.
--url <url>	URL portalu modelu semantycznego; wyprowadza identyfikatory przestrzeni roboczej i elementów.
--entity <name>	Encja lub tabela do próbki; pominięcie z do --query listy jednostek.
--query <path>	.sql lub .dax pliku do wykonania w trybie tylko do odczytu.
--rows <n>	Limit wierszy; domyślnie wynosi 10 dla próbek i jest ograniczony do 100.
-v, --verbose	Włącz pełne dane wyjściowe.
--output <interactive\|plain\|json>	Wybierz format wyjściowy.
--json	Emituj wyjście JSON.

Zastosowanie --name do skonfigurowanego złącza, pełnego selektora bezpośredniego źródła lub --url modelu semantycznego.

rayfin connector invoke [connector-name] [operation]

Wywołuje operację na skonfigurowanym złączu.

Argument lub opcja	Opis
[connector-name]	Skonfigurowana nazwa złącza.
[operation]	Działanie złącza, takie jak executeQuery.
--name <name>	Nazwana alternatywnie dla [connector-name].
--operation <operation>	Nazwana alternatywnie dla [operation].
--input <json>	Wejście operacji JSON.
--file <path>	pliku JSON zawierający wejście operacji.
--transport <auto\|deployed>	Ścieżka wywołania; domyślnie przyjmuje .auto
-v, --verbose	Włącz pełne dane wyjściowe.
--output <interactive\|plain\|json>	Wybierz format wyjściowy.
--output-file <path>	Zapisz pełny wynik do pliku.
--max-inline-bytes <bytes>	Próg rozmiaru wyniku dla zapisu pliku; domyślnie wynosi 1 MiB.
--json	Emituj wyjście JSON.

rayfin connector remove <name>

Usuwa deklarację złącza oraz wygenerowane przez nią pliki łączące.

Argument lub opcja	Opis
<name>	Required. Nazwę złącza trzeba usunąć.
-v, --verbose	Włącz pełne dane wyjściowe.
-y, --yes	Automatycznie zaakceptuj potwierdzenie usunięcia.
--json	Emituj wyjście JSON.

Polecenia funkcji

rayfin functions init [directory]

Konstruuje i konfiguruje pakiet Functions.

Argument lub opcja	Opis
[directory]	Project root; domyślnie do aktualnego katalogu.
--force	Nadpisz istniejące rusztowanie Funkcji.
--path <relative-path>	Lokalizacja pakietu funkcji względem korzenia projektu.

Lokalizacja pakietu domyślnie jest wykryta jako miejsce w przestrzeni roboczej lub rayfin/functions.

Komendy rozwojowe

rayfin dev [project-path]

Rozpoczyna lokalną sesję deweloperską na backendzie Rayfin.

Argument lub opcja	Opis
[project-path]	Project root; domyślnie do aktualnego katalogu.
--skip-db-apply	Pomiń automatyczną konfigurację bazy danych.
--env-file <path>	.env pliku używanego do rayfin.yml interpolacji.
--provider <fabric>	Dostawca backend; domyślnie używa .fabric
-w, --workspace <name>	Fabric workspace nazwa dla backendu pierwszego uruchomienia.
--workspace-id <id>	Fabric workspace ID dla backendu pierwszego uruchomienia.
--capacity-id <id>	Fabric capacity ID dla przestrzeni roboczej bez użytecznej pojemności.
-t, --tenant <id>	Identyfikator dzierżawcy Microsoft Entra.
--encryption-fallback-enabled	Zezwalaj na przechowywanie tokenów tekstu jawnego, gdy nie ma dostępnego łańcucha kluczy systemu.
--no-emit-env	Nie regeneruj pliku frameworka .env.local .
-v, --verbose	Włącz pełne rejestrowanie.

rayfin dev functions apply

Uruchamia lokalnego hosta Functions przeciwko aktywnemu wdrożeniu.

Option	Opis
--port <port>	port hosta Local Functions; domyślnie to 7071.
--inspect-port <port>	Node.js port inspektora; domyślnie .9229
--no-debug	Wyłącz inspektora Node.js.
--no-emit-env	Nie regeneruj pliku frameworka .env.local .
--verbose	Pokaż wynik diagnostyczny.
--json	Emituj wyjście JSON.
-y, --yes	Uciekaj bez interaktywnych podpowiedzi.

Zarządzaj plikami agentów

Polecenie zarządza rayfin init ai-files plikami kontekstowymi agenta Rayfin w Twoim projekcie: AGENTS.md, .mcp.json, oraz .agents/skills/rayfin/SKILL.md. CLI automatycznie instaluje te pliki, gdy rusztujesz projekt. Wykonaj poniższe polecenia, aby zainstalować lub odświeżyć je w istniejącym projekcie albo sprawdzić ich status.

rayfin init ai-files install

Instaluje lub odświeża pliki agenta Rayfin. Polecenie jest idempotentne i zachowuje istniejącą konfigurację użytkownika.

Option	Opis
--enable <id>	Zainstaluj lub zachowaj konkretny element według identyfikatora z przestrzenią nazw, takiego jak skill:rayfin. Powtarzalne.
--disable <id>	Przestań zarządzać konkretnym elementem bez usuwania jego pliku. Powtarzalne.
--remove-files	Usuń plik na dysku podczas wyłączania elementu. Wymaga --disable.
--force [ids...]	Nadpisywanie zmodyfikowanych przedmiotów, przywracanie brakujących elementów lub odbudowanie zdeformowanych .mcp.jsonelementów. Akceptuje opcjonalne identyfikatory w przestrzeni nazw, aby wykonać zakres operacji. Nigdy nie nadpisuje AGENTS.md.
-n, --dry-run	Zgłaszaj zmiany bez zapisywania plików.
--json	Emituj strukturalne wyjście jako JSON; implikuje tryb nieinteraktywny.
-y, --yes, --non-interactive	Pomiń interaktywny komunikat i zaakceptuj domyślne ustawienia.

Na przykład, instalacja domyślnie bez wywołania wypowiedzi:

npx rayfin init ai-files install --yes

rayfin init ai-files status

Wyświetla stan każdego pliku zarządzanego agenta. Zastosowanie --json do efektów strukturalnych.

Możliwe stany to up-to-date, update-available, user-modified, missing, not-installed, disabled, orphanedoraz .unreadable Uruchom, rayfin init ai-files install aby odświeżyć pliki lub rayfin init ai-files install --force <id> nadpisać konkretny zarządzany element.

Wdrażanie w Fabric

rayfin up

Użyj rayfin up do wdrożenia aplikacji na Fabric jako element Rayfin.

Argument	Opis
-t, --tenant <id>	Użyj konkretnego identyfikatora tenanta.
-w, --workspace <name>	Wdroż do przestrzeni roboczej Fabric po nazwie; domyślnie .My Workspace
--workspace-id <id>	Wdroż do konkretnego identyfikatora przestrzeni roboczej Fabric.
--workspace-uri <uri>	Wdroż do konkretnego URI Fabric workspace.
--item-name <name>	Fabric item display name; domyślnie używa ID projektu.
--capacity-id <id>	Fabric Capacity ID, gdy docelowa przestrzeń robocza potrzebuje pojemności.
--force	Pozwól na destrukcyjne zmiany schematu danych.
-n, --dry-run	Zweryfikuj dane wejściowe i rozwiązuj przestrzeń roboczą bez wdrażania.
--env-file <path>	.envpliku dla właściwości wdrożenia; domyślnie jest .rayfin/.env
-v, --verbose	Włącz pełne dane wyjściowe.
--json	Zwróć wyjście wdrożenia w formacie JSON.
-y, --yes	Automatycznie przyjmuj potwierdzenia.
--encryption-fallback-enabled	Zezwalaj na przechowywanie tokenów tekstu jawnego, gdy nie ma dostępnego łańcucha kluczy systemu.
--exclude-services <names>	Usługi rozdzielone przecinkami do pominięcia podczas budowy i wdrożenia: staticHosting lub functions.
--provider <fabric>	Dostawca wdrożenia; domyślnie przyjmuje .fabric

Examples

Wdroż do obecnie wybranego miejsca pracy Fabric:

npx rayfin up

Podgląd akcji wdrożenia bez ich zastosowania:

npx rayfin up --dry-run --verbose

Wdrożenie w konkretnym workspace bez interaktywności:

npx rayfin up --workspace-id <workspace-id> --yes

Wdrażaj bez budowania lub wdrażania Funkcje:

npx rayfin up --exclude-services functions

--capacity-id Nie można łączyć z --workspace, --workspace-id, ani --workspace-uri.

Subcommand	Opis
npx rayfin up db apply	Generuj i stosuj konfigurację DAB do zdalnego endpointu obciążenia elementów Rayfin.
npx rayfin up functions deploy	Buduj, pakuj i wdrażaj Funkcje na aktywnym elemencie zdalnym.
npx rayfin up staticapp deploy	Buduj, pakuj i wdrażaj statyczną zawartość na zdalnym przedmiocie Rayfin.
npx rayfin up connector apply	Zastosuj konfigurację bazy danych dla zadeklarowanych złączy GraphQL.
npx rayfin up status	Pokaż aktualny status wdrożenia.
npx rayfin up list	Wymień wszystkie wdrożenia Fabric zarejestrowane dla projektu.
npx rayfin up switch [workspace]	Przełącz aktywne Fabric wdrożenia i przepisz rayfin/.env.

rayfin up db apply

Generuje i stosuje konfigurację DAB do zdalnego punktu obciążenia elementów Rayfin.

Argument	Opis
--verbose	Pokaż szczegółowe dane wyjściowe.
--force	Wymusz regenerację i zastosuj konfigurację.
--json	Zwróć wyjście w formacie JSON.

Examples

Zastosuj zmiany konfiguracji bazy danych do zdalnego elementu Rayfin:

npx rayfin up db apply

Regeneracja sił i rejestrowanie odczytywalnych przez maszynę wyników:

npx rayfin up db apply --force --json

rayfin up functions deploy

Buduje, pakuje i wdraża Funkcje na aktywnym zdalnym elemencie.

Option	Opis
--verbose	Pokaż szczegółowe dane wyjściowe.
--skip-build	Wdroż istniejące wyjście Functions bez budowania.
--json	Emituj wyjście JSON.

rayfin up connector apply

Stosuje konfigurację bazy danych dla zadeklarowanych złączy GraphQL.

Option	Opis
--name <name>	Stosuj tylko nazwane złącze.
--verbose	Włącz pełne dane wyjściowe.
--json	Emituj wyjście JSON.

rayfin up staticapp deploy

Buduje, pakuje i wdraża statyczną zawartość do zdalnego przedmiotu Rayfin.

Argument	Opis
--verbose	Pokaż szczegółowe dane wyjściowe.
--skip-build	Wdroż bez uruchamiania etapu budowy.
--json	Zwróć wyjście w formacie JSON.

Examples

Buduj i wdrażaj statyczne treści:

npx rayfin up staticapp deploy

Wdroż gotowy dist folder bez ponownego uruchamiania builda:

npx rayfin up staticapp deploy --skip-build

rayfin up status

Wyświetla status wdrożenia w chmurze.

Argument	Opis
--json	Status powrotu w formacie JSON.
--verbose	Pokaż szczegółowe dane wyjściowe.

Examples

Sprawdź aktualny status wdrożenia:

npx rayfin up status

Zwróć status jako JSON do użycia w skryptach:

npx rayfin up status --json

rayfin up list

Lista wszystkich wdrożeń Fabric zarejestrowanych dla tego projektu.

Argument	Opis
--json	Zwróć listę wdrożeń w formacie JSON.

Examples

Wymień wszystkie zarejestrowane wdrożenia Fabric dla projektu:

npx rayfin up list

rayfin up switch [workspace]

Przełącza aktywne Fabric wdrożenia i przepisuje rayfin/.env odpowiednio.

Argument	Opis
-l, --list	Wypisz dostępne wdrożenia bez przełączania się.
--no-emit-env	Pomiń zapisywanie emitowanych plików środowiskowych.

Examples

Wymień dostępne wdrożenia do przejścia na:

npx rayfin up switch --list

Przełącz aktywne wdrożenie do konkretnego obszaru pracy:

npx rayfin up switch my-workspace

Generuj pliki środowiskowe

rayfin env

Użyj rayfin env do generowania wartości specyficznych .env.local dla ramy z rayfin/.env.

Argument	Opis
--framework <vite|nextjs|plain>	Wybierz format docelowej ramy.
--output <dir>	Zapisuj wygenerowane pliki do konkretnego katalogu.
--show	Drukuj wartości emitowane bez zapisywania plików.

Examples

Wygeneruj kompatybilność z Vite:.env.local

npx rayfin env --framework vite

Podgląd emitowanych wartości środowiskowych bez zapisu plików:

npx rayfin env --framework nextjs --show

Logowanie i wylogowywanie

rayfin login

Użyj do rayfin login logowania się na platformę Rayfin.

Argument	Opis
--tenant <id>	Użyj konkretnego identyfikatora tenanta.
--service-principal	Spróbuj zalogować się jako główny pracownik. Ta opcja jest wymieniona w pomocy, ale obecnie nie jest obsługiwana.
-u, --client-id <id>	Podaj identyfikator klienta do logowania się jako główny użytkownik usługi. Ta opcja jest wymieniona w pomocy, ale obecnie nie jest obsługiwana.
-p, --client-secret <secret>	Podaj sekret klienta do logowania się jako główny przedstawiciel usługi. Ta opcja jest wymieniona w pomocy, ale obecnie nie jest obsługiwana.
--select	Wybierz spośród dostępnych zalogowanych kont lub kontekstów.
--encryption-fallback-enabled	Włącz zachowanie zabezpieczające szyfrowanie.

Examples

Zaloguj się interaktywnie:

npx rayfin login

Zaloguj się do konkretnego najemcy:

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

Przełączaj się między kontami zalogowanymi:

npx rayfin login --select

Subcommand	Opis
npx rayfin login status	Wyświetlaj aktualny status uwierzytelniania.

rayfin login status

Wyświetla aktualny status uwierzytelniania.

Argument	Opis
Żadne	To podpolecenie nie zawiera żadnych opcji w wyjściu pomocy CLI.

Example

Sprawdź, czy jesteś zalogowany:

npx rayfin login status

rayfin logout

Wypisuje się i usuwa dane dane w pamięci podręcznej.

Argument	Opis
Żadne	To polecenie nie zawiera żadnych opcji w wyjściu pomocy CLI.

Example

Wyloguj się i usuń dane dane w pamięci podręcznej:

npx rayfin logout