Αναφορά Rayfin CLI

Βρείτε τις εντολές Rayfin CLI για τη δημιουργία έργων, τη διαχείριση αλλαγών σχήματος, την ανάπτυξη στο Fabric και τη ρύθμιση παραμέτρων περιβάλλοντος. Κάθε ενότητα παραθέτει τη σύνταξη εντολών, τις επιλογές και τις συνήθεις χρήσεις.

Εγκατάσταση

Χρησιμοποιήστε το 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

Συμβουλή

Για υπάρχοντα ή κενά έργα, χρησιμοποιήστε το npx rayfin init αντί npm create για να προσθέσετε το Rayfin σε ένα έργο που έχει ήδη πηγαίο κώδικα ή έναν κενό κατάλογο. Η εντολή init σάς καθοδηγεί στην ενεργοποίηση των υπηρεσιών, στην επιλογή μιας διαλέκτου βάσης δεδομένων και στη διαμόρφωση της στατικής φιλοξενίας χωρίς να δημιουργήσετε ένα νέο πρότυπο.

Για την πλήρη αναλυτική παρουσίαση, ανατρέξτε στο θέμα Δημιουργία και ανάπτυξη της πρώτης Fabric εφαρμογής σας με τα CLI και Ανάπτυξη εφαρμογής Fabric στο Fabric.

Σκαλωσιά ενός έργου με npm create

npm create (γνωστός και ως npm init) εκκινεί ένα νέο έργο καλώντας ένα πακέτο create initializer. Για να δημιουργήσετε μια εφαρμογή Fabric, χρησιμοποιήστε την με τον αρχικοποιητή @microsoft/rayfin:

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

Αναφορά εντολής

Οι εντολές και οι σημαίες σε αυτό το άρθρο επαληθεύτηκαν από την τοπικά εγκατεστημένη έξοδο βοήθειας CLI.

Εντολές ανώτατου επιπέδου

Χρησιμοποιήστε αυτόν τον πίνακα για να βρείτε γρήγορα τη σωστή εντολή.

Εντολή	Χρησιμοποιήστε το για να
npx rayfin init [directory]	Δημιουργήστε ή διαμορφώστε ένα έργο Rayfin.
npx rayfin up	Αναπτύξτε την εφαρμογή στο Fabric και διαχειριστείτε απομακρυσμένες αναπτύξεις.
npx rayfin env	Δημιουργήστε αρχεία περιβάλλοντος ειδικά για το πλαίσιο από rayfin/.envτο .
npx rayfin login	Συνδεθείτε στην πλατφόρμα Rayfin.
npx rayfin logout	Αποσυνδεθείτε και διαγράψτε τα προσωρινά αποθηκευμένα διαπιστευτήρια.

Δημιουργία ή ρύθμιση παραμέτρων έργου

rayfin init [directory]

Χρησιμοποιήστε το rayfin init για να προσθέσετε το Rayfin σε ένα νέο ή υπάρχον έργο.

Όρισμα	Περιγραφή
--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.
--workspace-uri <uri>	Χρησιμοποιήστε ένα συγκεκριμένο URI χώρου εργασίας Fabric.
--base-api-url <url>	Παρακάμψτε τη βασική διεύθυνση URL API.
--item-id <id>	Στοχεύστε ένα συγκεκριμένο αναγνωριστικό στοιχείου Fabric.

Παραδείγματα

Καταγράψτε τα διαθέσιμα πρότυπα πριν από τη σκαλωσιά:

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 για να αναπτύξετε την εφαρμογή για να Fabric ως στοιχείο Rayfin.

Όρισμα	Περιγραφή
--tenant <id>	Χρησιμοποιήστε ένα συγκεκριμένο αναγνωριστικό μισθωτή.
--workspace-id <id>	Ανάπτυξη σε ένα συγκεκριμένο αναγνωριστικό χώρου εργασίας Fabric.
--workspace-uri <uri>	Ανάπτυξη σε ένα συγκεκριμένο URI χώρου εργασίας Fabric.
--base-api-url <url>	Παρακάμψτε τη βασική διεύθυνση URL API.
--force	Βήματα ανάπτυξης δύναμης όταν χρειάζεται.
--dry-run	Κάντε προεπισκόπηση των ενεργειών ανάπτυξης χωρίς να τις εφαρμόσετε.
--env-file <path>	Φόρτωση τιμών περιβάλλοντος από ένα αρχείο.
--verbose	Εμφάνιση λεπτομερούς εξόδου ανάπτυξης.
--json	Επιστρέψτε την έξοδο ανάπτυξης σε μορφή JSON.
-y, --yes	Αυτόματη αποδοχή προτροπών.
--encryption-fallback-enabled	Ενεργοποίηση εναλλακτικής συμπεριφοράς κρυπτογράφησης.

Παραδείγματα

Ανάπτυξη στον τρέχοντα επιλεγμένο χώρο εργασίας Fabric:

npx rayfin up

Κάντε προεπισκόπηση των ενεργειών ανάπτυξης χωρίς να τις εφαρμόσετε:

npx rayfin up --dry-run --verbose

Ανάπτυξη σε συγκεκριμένο χώρο εργασίας μη αλληλεπιδραστικά:

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

Δευτερεύουσα δέσμευση	Περιγραφή
npx rayfin up db apply	Δημιουργήστε και εφαρμόστε τη διαμόρφωση DAB στο απομακρυσμένο τελικό σημείο φόρτου εργασίας στοιχείου Rayfin.
npx rayfin up staticapp deploy	Δημιουργήστε, συσκευάστε και αναπτύξτε στατικό περιεχόμενο στο απομακρυσμένο στοιχείο Rayfin.
npx rayfin up status	Εμφάνιση της τρέχουσας κατάστασης ανάπτυξης.
npx rayfin up list	Παραθέστε όλες τις αναπτύξεις Fabric που έχουν καταγραφεί για το έργο.
npx rayfin up switch [workspace]	Αλλάξτε την ενεργή ανάπτυξη Fabric και ξαναγράψτε rayfin/.env.

rayfin up db apply

Δημιουργεί και εφαρμόζει διαμόρφωση DAB στο απομακρυσμένο τελικό σημείο φόρτου εργασίας στοιχείου Rayfin.

Όρισμα	Περιγραφή
--verbose	Εμφάνιση λεπτομερούς εξόδου.
--force	Αναγκαστική αναγέννηση και εφαρμογή διαμόρφωσης.
--json	Επιστροφή εξόδου σε μορφή JSON.

Παραδείγματα

Εφαρμογή αλλαγών διαμόρφωσης βάσης δεδομένων στο απομακρυσμένο στοιχείο Rayfin:

npx rayfin up db apply

Αναγέννηση δύναμης και λήψη μηχανικά αναγνώσιμης εξόδου:

npx rayfin up db apply --force --json

rayfin up staticapp deploy

Δημιουργεί, συσκευάζει και αναπτύσσει στατικό περιεχόμενο στο απομακρυσμένο στοιχείο Rayfin.

Όρισμα	Περιγραφή
--verbose	Εμφάνιση λεπτομερούς εξόδου.
--skip-build	Ανάπτυξη χωρίς εκτέλεση του βήματος δόμησης.
--json	Επιστροφή εξόδου σε μορφή JSON.

Παραδείγματα

Δημιουργία και ανάπτυξη στατικού περιεχομένου:

npx rayfin up staticapp deploy

Αναπτύξτε έναν προκατασκευασμένο dist φάκελο χωρίς να εκτελέσετε ξανά τη δομή:

npx rayfin up staticapp deploy --skip-build

rayfin up status

Εμφανίζει την κατάσταση της ανάπτυξης cloud.

Όρισμα	Περιγραφή
--json	Επιστροφή κατάστασης σε μορφή JSON.
--verbose	Εμφάνιση λεπτομερούς εξόδου.

Παραδείγματα

Ελέγξτε την τρέχουσα κατάσταση ανάπτυξης:

npx rayfin up status

Επιστρέψτε την κατάσταση ως JSON για χρήση σε δέσμες ενεργειών:

npx rayfin up status --json

rayfin up list

Παραθέτει όλες τις αναπτύξεις Fabric που έχουν καταγραφεί για αυτό το έργο.

Όρισμα	Περιγραφή
--json	Επιστρέψτε τη λίστα ανάπτυξης σε μορφή JSON.

Παραδείγματα

Παραθέστε όλες τις καταγεγραμμένες αναπτύξεις Fabric για το έργο:

npx rayfin up list

rayfin up switch [workspace]

Αλλάζει την ενεργή Fabric την ανάπτυξη και ξαναγράφει το rayfin/.env ανάλογα.

Όρισμα	Περιγραφή
-l, --list	Καταχωρίστε τις διαθέσιμες αναπτύξεις χωρίς εναλλαγή.
--no-emit-env	Παράλειψη εγγραφής αρχείων περιβάλλοντος που εκπέμπονται.

Παραδείγματα

Λίστα διαθέσιμων αναπτύξεων για μετάβαση σε:

npx rayfin up switch --list

Αλλάξτε την ενεργή ανάπτυξη σε έναν συγκεκριμένο χώρο εργασίας:

npx rayfin up switch my-workspace

Δημιουργία αρχείων περιβάλλοντος

rayfin env

Χρησιμοποιείται για rayfin env την εκπομπή τιμών για συγκεκριμένο .env.local πλαίσιο από rayfin/.envτο .

Όρισμα	Περιγραφή
--framework <vite|nextjs|plain>	Επιλέξτε τη μορφή πλαισίου προορισμού.
--output <dir>	Γράψτε τα αρχεία που δημιουργούνται σε έναν συγκεκριμένο κατάλογο.
--show	Εκτυπώστε τις εκπεμπόμενες τιμές χωρίς εγγραφή αρχείων.

Παραδείγματα

Δημιουργήστε ένα συμβατό με .env.localVite:

npx rayfin env --framework vite

Προεπισκόπηση τιμών εκπεμπόμενου περιβάλλοντος χωρίς εγγραφή αρχείων:

npx rayfin env --framework nextjs --show

Είσοδος και αποσύνδεση

rayfin login

Χρησιμοποιήστε το rayfin login για να συνδεθείτε στην πλατφόρμα Rayfin.

Όρισμα	Περιγραφή
--tenant <id>	Χρησιμοποιήστε ένα συγκεκριμένο αναγνωριστικό μισθωτή.
--service-principal	Προσπαθήστε να συνδεθείτε στην κύρια υπηρεσία. Αυτή η επιλογή παρατίθεται στη βοήθεια, αλλά δεν υποστηρίζεται προς το παρόν.
-u, --client-id <id>	Καταχωρήστε το αναγνωριστικό προγράμματος-πελάτη για την είσοδο της κύριας υπηρεσίας. Αυτή η επιλογή παρατίθεται στη βοήθεια, αλλά δεν υποστηρίζεται προς το παρόν.
-p, --client-secret <secret>	Δώστε τον μυστικό κωδικό πελάτη για την είσοδο της κύριας υπηρεσίας. Αυτή η επιλογή παρατίθεται στη βοήθεια, αλλά δεν υποστηρίζεται προς το παρόν.
--select	Επιλέξτε από τους διαθέσιμους συνδεδεμένους λογαριασμούς ή περιβάλλοντα.
--encryption-fallback-enabled	Ενεργοποίηση εναλλακτικής συμπεριφοράς κρυπτογράφησης.

Παραδείγματα

Συνδεθείτε διαδραστικά:

npx rayfin login

Είσοδος σε συγκεκριμένο μισθωτή:

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

Εναλλαγή μεταξύ συνδεδεμένων λογαριασμών:

npx rayfin login --select

Δευτερεύουσα δέσμευση	Περιγραφή
npx rayfin login status	Εμφάνιση της τρέχουσας κατάστασης ελέγχου ταυτότητας.

rayfin login status

Εμφανίζει την τρέχουσα κατάσταση ελέγχου ταυτότητας.

Όρισμα	Περιγραφή
Χωρίς	Αυτή η υποεντολή δεν παραθέτει καμία επιλογή στην έξοδο βοήθειας CLI.

Παράδειγμα

Ελέγξτε αν είστε συνδεδεμένοι:

npx rayfin login status

rayfin logout

Αποσυνδέεται και διαγράφει τα προσωρινά αποθηκευμένα διαπιστευτήρια.

Όρισμα	Περιγραφή
Χωρίς	Αυτή η εντολή δεν παραθέτει καμία επιλογή στην έξοδο βοήθειας CLI.

Παράδειγμα

Αποσυνδεθείτε και διαγράψτε τα προσωρινά αποθηκευμένα διαπιστευτήρια:

npx rayfin logout