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
npm run 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 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

Wdrażanie w Fabric

rayfin up

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

Argument	Opis
--tenant <id>	Użyj konkretnego identyfikatora tenanta.
--workspace-id <id>	Wdroż do konkretnego identyfikatora przestrzeni roboczej Fabric.
--workspace-uri <uri>	Wdroż do konkretnego URI Fabric workspace.
--base-api-url <url>	Nadpisz bazowy adres URL API.
--force	Wymuszać kroki wdrożenia, gdy zajdzie taka potrzeba.
--dry-run	Podgląd akcji wdrożenia bez ich stosowania.
--env-file <path>	Ładuj wartości środowiska z pliku.
--verbose	Pokaż rozbudowane wyniki wdrożenia.
--json	Zwróć wyjście wdrożenia w formacie JSON.
-y, --yes	Akceptuj powiadomienia automatycznie.
--encryption-fallback-enabled	Włącz zachowanie zabezpieczające szyfrowanie.

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 00000000-0000-0000-0000-000000000000 --yes

Subcommand	Opis
npx rayfin up db apply	Generuj i stosuj konfigurację DAB do zdalnego endpointu obciążenia elementów Rayfin.
npx rayfin up staticapp deploy	Buduj, pakuj i wdrażaj statyczną zawartość na zdalnym przedmiocie Rayfin.
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 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