מסמך עזר של Firebase CLI

ה-CLI של Firebase (GitHub) מספק מגוון כלים לניהול, לצפייה ולפריסה של פרויקטים ב-Firebase.

לפני שמשתמשים ב-CLI של Firebase, צריך להגדיר פרויקט Firebase.

הגדרה או עדכון של ה-CLI

התקנת ה-CLI של Firebase

אתם יכולים להתקין את ה-CLI של Firebase בשיטה שמתאימה למערכת ההפעלה, לרמת הניסיון ו/או לתרחיש לדוגמה שלכם. לא משנה איך מתקינים את ה-CLI, תהיה לכם גישה לאותה פונקציונליות ולפקודה firebase.

Windows macOS Linux

Windows

אפשר להתקין את ה-CLI של Firebase ל-Windows באחת מהאפשרויות הבאות:

אפשרות	תיאור	מומלץ ל...
קובץ בינארי עצמאי	מורידים את קובץ הבינארי העצמאי של ה-CLI. לאחר מכן תוכלו לגשת לקובץ ההפעלה כדי לפתוח מעטפת שבה תוכלו להריץ את הפקודה firebase.	מפתחים חדשים מפתחים שלא משתמשים ב-Node.js או לא מכירים אותו
npm	משתמשים ב-npm (מנהל החבילות של Node) כדי להתקין את ה-CLI ולהפעיל את הפקודה firebase שזמינה בכל העולם.	מפתחים שמשתמשים ב-Node.js

macOS או Linux

אפשר להתקין את ה-CLI של Firebase ל-macOS או ל-Linux באחת מהאפשרויות הבאות:

אפשרות	תיאור	מומלץ ל...
סקריפט התקנה אוטומטי	מריצים פקודה אחת שמזהה באופן אוטומטי את מערכת ההפעלה, מורידים את הגרסה האחרונה של ה-CLI ומפעילים את הפקודה firebase שזמינה בכל העולם.	מפתחים חדשים מפתחים שלא משתמשים ב-Node.js או לא מכירים אותו פריסות אוטומטיות בסביבת CI/CD
קובץ בינארי עצמאי	מורידים את קובץ הבינארי העצמאי של ה-CLI. לאחר מכן תוכלו להגדיר ולהריץ את קובץ הבינארי בהתאם לתהליך העבודה שלכם.	תהליכי עבודה שניתן להתאים אישית באופן מלא באמצעות ה-CLI
npm	משתמשים ב-npm (מנהל החבילות של Node) כדי להתקין את ה-CLI ולהפעיל את הפקודה firebase שזמינה באופן גלובלי.	מפתחים שמשתמשים ב-Node.js

התחברות ובדיקה של ה-CLI של Firebase

אחרי התקנת ה-CLI, צריך לבצע אימות. לאחר מכן תוכלו לאשר את האימות על ידי הצגת הפרויקטים ב-Firebase.

1. מתחברים ל-Firebase באמצעות חשבון Google על ידי הפעלת הפקודה הבאה:

   firebase login

   הפקודה הזו מקשרת את המחשב המקומי ל-Firebase ומעניקה לכם גישה לפרויקטים ב-Firebase.

2. כדי לבדוק אם ה-CLI מותקן כמו שצריך ויש לו גישה לחשבון, תוכלו להציג את רשימת הפרויקטים ב-Firebase. מריצים את הפקודה הבאה:

   firebase projects:list

   הרשימה שמוצגת אמורה להיות זהה לפרויקטים ב-Firebase שמפורטים במסוף Firebase.

עדכון לגרסה האחרונה של CLI

באופן כללי, מומלץ להשתמש בגרסה העדכנית ביותר של CLI של Firebase.

האופן שבו מעדכנים את גרסת ה-CLI תלוי במערכת ההפעלה ובאופן שבו התקנתם את ה-CLI.

שימוש ב-CLI עם מערכות CI

כדי להשלים את תהליך האימות ב-CLI של Firebase נדרש דפדפן, אבל ה-CLI תואם באופן מלא ל-CI ולסביבות ללא ממשק משתמש (headless) אחרות.

1. במכונה עם דפדפן, מתקינים את ה-CLI של Firebase.

2. כדי להתחיל את תהליך הכניסה, מריצים את הפקודה הבאה:

   firebase login:ci

3. נכנסים לכתובת ה-URL שצוינה ומתחברים באמצעות חשבון Google.

4. מדפיסים אסימון רענון חדש. סשן ה-CLI הנוכחי לא יושפע.

5. מאחסנים את אסימון הפלט באופן מאובטח אבל נגיש במערכת ה-CI.

6. משתמשים באסימון הזה כשמריצים פקודות firebase. אפשר להשתמש באחת משתי האפשרויות הבאות:

   • אפשרות 1: שומרים את האסימון כמשתנה הסביבה FIREBASE_TOKEN. המערכת תשתמש בטוקן באופן אוטומטי.

   • אפשרות 2: מריצים את כל הפקודות של firebase עם הדגל --token TOKEN במערכת ה-CI.
     זוהי סדר העדיפויות לטעינת האסימון: דגל, משתנה סביבה, פרויקט Firebase הרצוי.

איך מפעילים פרויקט Firebase

משימות נפוצות רבות שמבצעים באמצעות ה-CLI, כמו פריסת אפליקציה בפרויקט Firebase, דורשות ספריית פרויקט. מגדירים ספריית פרויקט באמצעות הפקודה firebase init. בדרך כלל, תיקיית הפרויקט היא אותה תיקייה כמו תיקיית השורש של בקרת הגרסאות. אחרי שמריצים את firebase init, התיקייה מכילה קובץ תצורה בשם firebase.json.

כדי לאתחל פרויקט Firebase חדש, מריצים את הפקודה הבאה מהספרייה של האפליקציה:

firebase init

הפקודה firebase init מובילה אתכם בתהליך ההגדרה של ספריית הפרויקט ושל חלק ממוצרים של Firebase. במהלך האיפוס של הפרויקט, תתבקשו לבצע את המשימות הבאות ב-CLI של Firebase:

• בוחרים את מוצרי Firebase הרצויים להגדרה בפרויקט Firebase.

  בשלב הזה תתבקשו להגדיר הגדרות לקובצי ספציפיים של המוצרים שנבחרו. פרטים נוספים על ההגדרות האלה מופיעים במסמכי התיעוד של המוצר הספציפי (לדוגמה, Hosting). חשוב לזכור שאפשר תמיד להריץ את firebase init מאוחר יותר כדי להגדיר מוצרים נוספים של Firebase.

• בוחרים פרויקט ברירת מחדל ב-Firebase.

  בשלב הזה משויך ספריית הפרויקט הנוכחית לפרויקט Firebase, כדי שאפשר יהיה להריץ פקודות ספציפיות לפרויקט (כמו firebase deploy) בפרויקט Firebase המתאים.

  אפשר גם לשייך כמה פרויקטים של Firebase (למשל פרויקט Staging ופרויקט ייצור) לאותה ספריית פרויקטים.

בסיום תהליך האתחול, מערכת Firebase יוצרת באופן אוטומטי את שני הקובצים הבאים בתיקיית השורש של האפליקציה המקומית:

• קובץ תצורה firebase.json שמפרט את הגדרות הפרויקט.

• קובץ .firebaserc שבו מאוחסנים החלופות של הפרויקט.

הקובץ firebase.json

הפקודה firebase init יוצרת קובץ תצורה firebase.json בתיקיית השורש של הפרויקט.

קובץ firebase.json נדרש כדי לפרוס נכסים באמצעות ה-CLI של Firebase, כי הוא מציין אילו קבצים והגדרות מספריית הפרויקט יפורסו בפרויקט Firebase. מאחר שאפשר להגדיר חלק מההגדרות בספריית הפרויקט או במסוף Firebase, חשוב לפתור את כל ההתנגשויות האפשריות בפריסה.

אפשר להגדיר את רוב האפשרויות של Firebase Hosting ישירות בקובץ firebase.json. עם זאת, בשירותי Firebase אחרים שאפשר לפרוס באמצעות ה-CLI של Firebase, הפקודה firebase init יוצרת קבצים ספציפיים שבהם אפשר להגדיר את ההגדרות של השירותים האלה, כמו קובץ index.js ל-Cloud Functions. אפשר גם להגדיר ווקים לפריסה מראש או לאחר פריסה בקובץ firebase.json.

הקובץ הבא הוא דוגמה לקובץ firebase.json עם הגדרות ברירת המחדל אם בוחרים ב-Firebase Hosting, ב-Cloud Firestore וב-Cloud Functions for Firebase (עם אפשרויות המקור והניפוי של TypeScript שנבחרו) במהלך האיפוס.

{
  "hosting": {
    "public": "public",
    "ignore": [
      "firebase.json",
      "**/.*",
      "**/node_modules/**"
    ]
  },
  "firestore": {
      "rules": "firestore.rules",
      "indexes": "firestore.indexes.json"
  },
  "functions": {
    "predeploy": [
      "npm --prefix \"$RESOURCE_DIR\" run lint",
      "npm --prefix \"$RESOURCE_DIR\" run build"
    ]
  }
}

כברירת מחדל, המערכת משתמשת ב-firebase.json, אבל אפשר להעביר את הדגל --config PATH כדי לציין קובץ תצורה חלופי.

הגדרה של כמה מסדי נתונים של Cloud Firestore

כשמריצים את firebase init, קובץ firebase.json מכיל מפתח firestore יחיד שתואם למסד הנתונים שמוגדר כברירת מחדל בפרויקט, כפי שמוצג למעלה.

אם הפרויקט מכיל כמה מסדי נתונים מסוג Cloud Firestore, צריך לערוך את הקובץ firebase.json כדי לשייך לכל מסד נתונים קובצי מקור שונים של Cloud Firestore Security Rules ושל אינדקס מסד נתונים. משנים את הקובץ באמצעות מערך JSON, עם רשומה אחת לכל מסד נתונים.

      "firestore": [
        {
          "database": "(default)",
          "rules": "firestore.default.rules",
          "indexes": "firestore.default.indexes.json"
        },
        {
          "database": "ecommerce",
          "rules": "firestore.ecommerce.rules",
          "indexes": "firestore.ecommerce.indexes.json"
        }
      ],

Cloud Functions קבצים שאפשר להתעלם מהם בפריסה

בזמן הפריסה של הפונקציה, ה-CLI מציין באופן אוטומטי רשימת קבצים בתיקייה functions שצריך להתעלם מהם. כך אפשר למנוע פריסה לקצה העורפי של קבצים מיותרים שיכולים להגדיל את נפח הנתונים של הפריסה.

רשימת הקבצים שהמערכת מתעלמת מהם כברירת מחדל, שמוצגת בפורמט JSON:

"ignore": [
  ".git",
  ".runtimeconfig.json",
  "firebase-debug.log",
  "firebase-debug.*.log",
  "node_modules"
]

אם מוסיפים ערכים מותאמים אישית משלכם ל-ignore ב-firebase.json, חשוב לשמור (או להוסיף, אם היא חסרה) את רשימת הקבצים שמוצגת למעלה.

ניהול כינויים של פרויקטים

אפשר לשייך כמה פרויקטים של Firebase לאותה ספריית פרויקטים. לדוגמה, יכול להיות שתרצו להשתמש בפרויקט Firebase אחד ל-Staging ובפרויקט אחר ל-production. שימוש בסביבות פרויקטים שונות מאפשר לאמת שינויים לפני הפריסה בסביבת הייצור. הפקודה firebase use מאפשרת לעבור בין כתובות אימייל חלופיות וליצור כתובות אימייל חלופיות חדשות.

הוספת כינוי לפרויקט

כשאתם בוחרים פרויקט Firebase במהלך הפעלת הפרויקט, הפרויקט מקבל באופן אוטומטי את הכינוי default. עם זאת, כדי לאפשר לפקודות ספציפיות לפרויקט לפעול בפרויקט אחר ב-Firebase, ועדיין להשתמש באותה ספריית הפרויקט, מריצים את הפקודה הבאה מתוך ספריית הפרויקט:

firebase use --add

הפקודה הזו תגרום להצגת הודעה שבה תתבקשו לבחור פרויקט Firebase אחר ולהקצות את הפרויקט ככינוי. הקצאות של כתובות אימייל חלופיות נכתבות בקובץ .firebaserc בספריית הפרויקט.

שימוש בכינויים של פרויקטים

כדי להשתמש בכינויים שהוקצו לפרויקטים ב-Firebase, מריצים כל אחת מהפקודות הבאות מתוך ספריית הפרויקט.

פקודה	תיאור
firebase use	הצגת רשימה של כינויים שהוגדרו כרגע לספריית הפרויקט
firebase use \ PROJECT_ID|ALIAS	הפקודה הזו מורה להריץ את כל הפקודות בפרויקט Firebase שצוין. ה-CLI משתמש בפרויקט הזה בתור 'הפרויקט הפעיל' הנוכחי.
firebase use --clear	ניקוי הפרויקט הפעיל. מריצים את הפקודה firebase use PROJECT_ID|ALIAS כדי להגדיר פרויקט פעיל חדש לפני שמריצים פקודות אחרות ב-CLI.
firebase use \ --unalias PROJECT_ALIAS	הסרת כתובת חלופית מהספרייה של הפרויקט.

כדי לשנות את הפרויקט הפעיל הנוכחי, אפשר להעביר את הדגל --project עם כל פקודה ב-CLI. לדוגמה: אפשר להגדיר את ה-CLI כך שיפעל בפרויקט Firebase שהקציתם לו את הכינוי staging. אם רוצים להריץ פקודה אחת בפרויקט Firebase שהוקצה לו הכינוי prod, אפשר להריץ, לדוגמה, את הפקודה firebase deploy --project=prod.

בקרת גרסאות וכינויים לפרויקטים

באופן כללי, כדאי להכניס את הקובץ .firebaserc למערכת בקרת הגרסאות כדי לאפשר לצוות לשתף כינויים של פרויקטים. עם זאת, בפרויקטים בקוד פתוח או בתבניות להתחלה, בדרך כלל לא צריך להוסיף את הקובץ .firebaserc למערכת בקרת הגרסאות.

אם יש לכם פרויקט פיתוח לשימוש עצמי בלבד, תוכלו להעביר את הדגל --project עם כל פקודה או להריץ את firebase use PROJECT_ID בלי להקצות כינוי לפרויקט Firebase.

הצגה ובדיקה של פרויקט Firebase באופן מקומי

אתם יכולים להציג ולבדוק את פרויקט Firebase בכתובות URL שמתארחות באופן מקומי לפני הפריסה בסביבת הייצור. אם רוצים לבדוק רק תכונות נבחרות, אפשר להשתמש ברשימת תכונות מופרדות בפסיקים בדגל של הפקודה firebase serve.

מריצים את הפקודה הבאה מהשורש של ספריית הפרויקט המקומית כדי לבצע אחת מהמשימות הבאות:

• הצגת התוכן הסטטי של האפליקציה שמתארחת ב-Firebase.
• אתם משתמשים ב-Cloud Functions כדי ליצור תוכן דינמי עבור Firebase Hosting, ואתם רוצים להשתמש בפונקציות ה-HTTP של ייצור (פריסה) כדי לדמות את Hosting בכתובת URL מקומית.

firebase serve --only hosting

הדמיה של הפרויקט באמצעות פונקציות HTTP מקומיות

כדי לדמות את הפרויקט באמצעות פונקציות HTTP מקומיות, מריצים את אחת מהפקודות הבאות מתוך ספריית הפרויקט.

• כדי לדמות פונקציות HTTP ואירוח לצורך בדיקה בכתובות URL מקומיות, משתמשים באחת מהפקודות הבאות:

  firebase serve

  firebase serve --only functions,hosting // uses a flag

• כדי לדמות פונקציות HTTP בלבד, משתמשים בפקודה הבאה:

  firebase serve --only functions

בדיקה ממכשירים מקומיים אחרים

כברירת מחדל, firebase serve מגיב רק לבקשות מ-localhost. כלומר, תוכלו לגשת לתוכן המתארח מהדפדפן האינטרנט של המחשב, אבל לא ממכשירים אחרים ברשת. אם רוצים לבדוק ממכשירים מקומיים אחרים, משתמשים בדגל --host באופן הבא:

firebase serve --host 0.0.0.0  // accepts requests to any host

פריסה בפרויקט Firebase

ה-CLI של Firebase מנהל את הפריסה של קוד ונכסים בפרויקט Firebase, כולל:

• גרסאות חדשות של האתרים שלכם ב-Firebase Hosting
• Cloud Functions for Firebase חדש, מעודכן או קיים
• חיבורים וסכימות חדשים או מעודכנים ל-Firebase Data Connect
• כללים ל-Firebase Realtime Database
• כללים ל-Cloud Storage for Firebase
• כללים ל-Cloud Firestore
• מדדים של Cloud Firestore

כדי לפרוס בפרויקט Firebase, מריצים את הפקודה הבאה מהספרייה של הפרויקט:

firebase deploy

אפשר גם להוסיף הערה לכל אחת מהפריסות. התגובה הזו תוצג עם פרטי הפריסה האחרים בדף Firebase Hosting של הפרויקט. לדוגמה:

firebase deploy -m "Deploying the best new feature ever."

כשמשתמשים בפקודה firebase deploy, חשוב לשים לב לדברים הבאים:

• כדי לפרוס משאבים מתיקיית פרויקט, צריך שתהיה בתיקיית הפרויקט קובץ firebase.json. הקובץ הזה נוצר באופן אוטומטי באמצעות הפקודה firebase init.

• כברירת מחדל, הפקודה firebase deploy יוצרת גרסה זמינה לפריסה של כל המשאבים בספריית הפרויקט. כדי לפרוס שירותים או תכונות ספציפיים של Firebase, צריך להשתמש בפריסה חלקית.

התנגשויות בפריסה של כללי אבטחה

ב-Firebase Realtime Database, ב-Cloud Storage for Firebase וב-Cloud Firestore, אפשר להגדיר כללי אבטחה בספריית הפרויקט המקומית או במסוף Firebase.

אפשרות נוספת למניעת התנגשויות בפריסה היא להשתמש בפריסה חלקית ולהגדיר כללים רק במסוף Firebase.

מכסות לפריסה

יכול להיות (אבל לא סביר) שתחרגו ממכסה שמגבילה את הקצב או את הנפח של פעולות הפריסה ב-Firebase. לדוגמה, כשפורסים מספר גדול מאוד של פונקציות, עשויה להופיע הודעת השגיאה HTTP 429 Quota. כדי לפתור בעיות כאלה, כדאי לנסות פריסה חלקית.

ביטול פריסה

אפשר לבצע חזרה לאחור של פריסה של Firebase Hosting מדף Firebase Hosting של הפרויקט, על ידי בחירה בפעולה Rollback לגרסה הרצויה.

בשלב זה אי אפשר לבטל גרסאות של כללי אבטחה ל-Firebase Realtime Database, ל-Cloud Storage for Firebase או ל-Cloud Firestore.

פריסת שירותי Firebase ספציפיים

אם רוצים לפרוס רק שירותים או תכונות ספציפיים של Firebase, אפשר להשתמש ברשימת ערכים מופרדים בפסיקים בדגל בפקודה firebase deploy. לדוגמה, הפקודה הבאה פורסת את כללי האבטחה Firebase Hosting ואת כללי התוכן Cloud Storage.

firebase deploy --only hosting,storage

בטבלה הבאה מפורטים השירותים והתכונות שזמינים לפריסה חלקית. השמות בדגלים תואמים למפתחות בקובץ התצורה firebase.json.

תחביר הדגל	שירות או תכונה שנפרסו
--only hosting	תוכן בFirebase Hosting
--only database	כללי Firebase Realtime Database
--only dataconnect	Firebase Data Connect סכמות ומחברים
--only storage	כללי Cloud Storage for Firebase
--only firestore	כללי Cloud Firestore ואינדקסים לכל מסדי הנתונים שהוגדרו
--only functions	Cloud Functions for Firebase (אפשר להשתמש בגרסאות ספציפיות יותר של הדגל הזה)

פריסת פונקציות ספציפיות

כשפורסים פונקציות, אפשר לטרגט פונקציות ספציפיות. לדוגמה:

firebase deploy --only functions:function1

firebase deploy --only functions:function1,functions:function2

אפשרות אחרת היא לקבץ פונקציות לקבוצות ייצוא בקובץ /functions/index.js. קיבוץ פונקציות מאפשר לפרוס כמה פונקציות באמצעות פקודה אחת.

לדוגמה, אפשר לכתוב את הפונקציות הבאות כדי להגדיר groupA ו-groupB:

var functions = require('firebase-functions/v1');

exports.groupA = {
  function1: functions.https.onRequest(...),
  function2: functions.database.ref('\path').onWrite(...)
}
exports.groupB = require('./groupB');

בדוגמה הזו, קובץ functions/groupB.js נפרד מכיל פונקציות נוספות שמגדירות באופן ספציפי את הפונקציות ב-groupB. לדוגמה:

var functions = require('firebase-functions/v1');

exports.function3 = functions.storage.object().onChange(...);
exports.function4 = functions.analytics.event('in_app_purchase').onLog(...);

בדוגמה הזו, אפשר לפרוס את כל הפונקציות של groupA על ידי הפעלת הפקודה הבאה מספריית הפרויקט:

firebase deploy --only functions:groupA

לחלופין, אפשר לטרגט פונקציה ספציפית בתוך קבוצה על ידי הפעלת הפקודה הבאה:

firebase deploy --only functions:groupA.function1,groupB.function4

מחיקת פונקציות

ב-CLI של Firebase יש תמיכה בפקודות ובאפשרויות הבאות למחיקת פונקציות שפרסמתם בעבר:

• מחיקת כל הפונקציות שתואמות לשם שצוין בכל האזורים:

  firebase functions:delete FUNCTION-1_NAME

• מחיקת פונקציה ספציפית שפועלת באזור שאינו ברירת המחדל:

  firebase functions:delete FUNCTION-1_NAME --region REGION_NAME

• מחיקה של יותר מפונקציה אחת:

  firebase functions:delete FUNCTION-1_NAME FUNCTION-2_NAME

• מחיקה של קבוצת פונקציות שהוגדרה:

  firebase functions:delete GROUP_NAME

• עקיפת ההודעה לאישור:

  firebase functions:delete FUNCTION-1_NAME --force

הגדרת משימות בסקריפט לפני הפריסה ואחרי הפריסה

אפשר לקשר סקריפטים של מעטפת לפקודה firebase deploy כדי לבצע משימות לפני הפריסה או אחרי הפריסה. לדוגמה, סקריפט לטרום פריסה יכול להמיר קוד TypeScript ל-JavaScript, ו-hook לפריסה יכול להודיע לאדמינים על פריסה של תוכן אתר חדש ב-Firebase Hosting.

כדי להגדיר ווקים לפריסה מראש או לפריסה לאחר מכן, מוסיפים סקריפטים של bash לקובץ התצורה firebase.json. אפשר להגדיר סקריפטים קצרים ישירות בקובץ firebase.json, או להפנות לקבצים אחרים שנמצאים בספריית הפרויקט.

לדוגמה, הסקריפט הבא הוא הביטוי firebase.json של משימה לאחר הפריסה ששולחת הודעה ב-Slack לאחר פריסה מוצלחת ב-Firebase Hosting.

"hosting": {
  // ...

  "postdeploy": "./messageSlack.sh 'Just deployed to Firebase Hosting'",
  "public": "public"
}

קובץ הסקריפט messageSlack.sh נמצא בספריית הפרויקט ונראה כך:

curl -X POST -H 'Content-type: application/json' --data '{"text":"$1"}'
     \https://SLACK_WEBHOOK_URL

אפשר להגדיר הוקים של predeploy ו-postdeploy לכל אחד מהנכסים שאפשר לפרוס. חשוב לזכור שהרצת firebase deploy מפעילה את כל המשימות שלפני הפריסה ואחרי הפריסה שמוגדרות בקובץ firebase.json. כדי להריץ רק את המשימות שמשויכות לשירות Firebase ספציפי, משתמשים בפקודות פריסת חלקית.

גם ה-hooks של predeploy וגם ה-hooks של postdeploy מדפיסים בטרמינל את הפלט הסטנדרטי ואת הזרמים של השגיאות של הסקריפטים. במקרים של כשל, חשוב לשים לב לנקודות הבאות:

• אם ה-hook של הפריסה מראש לא מסתיים כצפוי, הפריסה מבוטלת.
• אם הפריסה נכשלת מסיבה כלשהי, ה-hooks שלאחר הפריסה לא מופעלים.

משתני סביבה

בסקריפטים שפועלים ב-predeploy וב-postdeploy hooks, משתני הסביבה הבאים זמינים:

• $GCLOUD_PROJECT: מזהה הפרויקט הפעיל
• $PROJECT_DIR: תיקיית השורש שמכילה את הקובץ firebase.json
• $RESOURCE_DIR: (לסקריפטים של hosting ו-functions בלבד) המיקום של הספרייה שמכילה את המשאבים מסוג Hosting או Cloud Functions לפריסה

ניהול של כמה מכונות Realtime Database

פרויקט Firebase יכול לכלול מספר מכונות Firebase Realtime Database. כברירת מחדל, פקודות ה-CLI פועלות עם מכונה של מסד נתונים שמוגדרת כברירת מחדל.

עם זאת, אפשר לבצע פעולות במכונה של מסד נתונים שאינה ברירת המחדל באמצעות הדגל --instance DATABASE_NAME. הפקודות הבאות תומכות בדגל --instance:

• firebase database:get
• firebase database:profile
• firebase database:push
• firebase database:remove
• firebase database:set
• firebase database:update

הפניה לפקודה

פקודות ניהול ב-CLI

פקודה	תיאור
עזרה	הצגת מידע עזרה על CLI או על פקודות ספציפיות.
init	שיוך והגדרה של פרויקט Firebase חדש בספרייה הנוכחית. הפקודה הזו יוצרת קובץ תצורה בשם firebase.json בספרייה הנוכחית.
login	אימות ה-CLI לחשבון Firebase. נדרשת גישה לדפדפן אינטרנט. כדי להתחבר ל-CLI בסביבות מרוחקות שלא מאפשרות גישה ל-localhost, משתמשים בדגל --no-localhost.
login:ci	יצירת אסימון אימות לשימוש בסביבות לא אינטראקטיביות.
logout	יציאה מה-CLI מחשבון Firebase.
open	פתיחת דפדפן עם משאבי הפרויקט הרלוונטיים.
projects:list	כאן מפורטים כל הפרויקטים ב-Firebase שיש לכם גישה אליהם.
שימוש	הגדרת פרויקט Firebase הפעיל ב-CLI. ניהול כינוי לפרויקט.

פקודות לניהול פרויקטים

פקודה	תיאור
ניהול פרויקטים ב-Firebase
projects:addfirebase	הוספת משאבים של Firebase לפרויקט Google Cloud קיים.
projects:create	יצירת פרויקט Google Cloud חדש, ואז הוספת משאבי Firebase לפרויקט החדש.
projects:list	כאן מפורטים כל הפרויקטים ב-Firebase שיש לכם גישה אליהם.
ניהול אפליקציות Firebase (iOS, ‏ Android, ‏ Web)
apps:create	יצירת אפליקציית Firebase חדשה בפרויקט הפעיל.
apps:list	רשימה של אפליקציות Firebase הרשומים בפרויקט הפעיל.
apps:sdkconfig	הדפסת תצורת שירותי Google של אפליקציית Firebase.
setup:web	התכונה הוצאה משימוש. במקום זאת, צריך להשתמש ב-apps:sdkconfig ולציין את web כארגומנטים של הפלטפורמה. הדפסה של ההגדרות של שירותי Google באפליקציית אינטרנט של Firebase.
ניהול גיבוב של אישורי SHA (Android בלבד)
apps:android:sha:create \ FIREBASE_APP_ID SHA_HASH	הוספת גיבוב האישור של SHA שצוין לאפליקציית Firebase ל-Android שצוינה.
apps:android:sha:delete \ FIREBASE_APP_ID SHA_HASH	הפונקציה מוחקת את גיבוב האישור של SHA שצוין מהאפליקציה של Firebase ל-Android.
apps:android:sha:list \ FIREBASE_APP_ID	הצגת גרסאות הגיבוב של אישורי ה-SHA של אפליקציית Firebase ל-Android שצוינה.

פריסה ופיתוח מקומי

הפקודות האלה מאפשרות לפרוס את האתר של Firebase Hosting ולנהל איתו אינטראקציה.

פקודה	תיאור
פריסה	פריסת קוד ונכסים מספריית הפרויקט לפרויקט הפעיל. עבור Firebase Hosting, נדרש קובץ תצורה של firebase.json.
serve	הפעלת שרת אינטרנט מקומי עם ההגדרות של Firebase Hosting. עבור Firebase Hosting, נדרש קובץ תצורה של firebase.json.

פקודות App Distribution

פקודה	תיאור
appdistribution:distribute \ --app FIREBASE_APP_ID	הפיכת הגרסה הזמינה לבודקים.
appdistribution:testers:add	הוספת בודקים לפרויקט.
appdistribution:testers:remove	הסרת בודקים מהפרויקט.

פקודות App Hosting

פקודה	תיאור
apphosting:backends:create \ --project PROJECT_ID \ --location REGION --app APP_ID	יצירת האוסף של המשאבים המנוהלים שמקושרים לקוד בסיס אחד, שמכיל קצה עורפי של App Hosting. אפשר לציין אפליקציית אינטרנט קיימת ב-Firebase לפי מזהה האפליקציה ב-Firebase.
apphosting:backends:get \ BACKEND_ID \ --project PROJECT_ID \ --location REGION	אחזור פרטים ספציפיים, כולל כתובת ה-URL הציבורית, של קצה עורפי.
apphosting:backends:list \ --project PROJECT_ID	אחזור רשימה של כל הקצוות העורפי הפעילים שמשויכים לפרויקט.
firebase apphosting:backends:delete \ BACKEND_ID \ --project PROJECT_ID \ --location REGION	מחיקת קצה עורפי מהפרויקט.
firebase apphosting:config:export \ --project PROJECT_ID \ --secrets ENVIRONMENT_NAME	ייצוא סודות לשימוש בהדמיה של אפליקציות. כברירת מחדל, הסודות שמאוחסנים ב-apphosting.yaml, או --secrets כדי לציין כל סביבה שיש לה קובץ apphosting.ENVIRONMENT_NAME.yaml תואם.
firebase apphosting:rollouts:create \ BACKEND_ID \ --git_branch BRANCH_NAME \ --git_commit COMMIT_ID	יצירת השקה שמופעל באופן ידני. אפשר לציין את השמירה האחרונה בהסתעפות או שמירה ספציפית. אם לא צוינו אפשרויות, תוצג בקשה לבחירה מתוך רשימת ההסתעפויות.
apphosting:secrets:set KEY --project PROJECT_ID \ --location REGION \ --data-file DATA_FILE_PATH	אחסון חומרים סודיים ב-Secret Manager. אפשר לציין נתיב לקובץ שממנו יקראו את הנתונים הסודיים. מגדירים את הערך ל-_ כדי לקרוא נתונים סודיים מקלט רגיל.
apphosting:secrets:grantaccess KEY BACKEND_ID \ --project PROJECT_ID \ --location REGION	מעניק לחשבון השירות לקצה העורפי גישה לסוד שסופק, כדי ש-App Hosting יוכל לגשת אליו בזמן ה-build או זמן הריצה.
apphosting:secrets:describe KEY \ --project PROJECT_ID	אחזור המטא-נתונים של סוד והגרסאות שלו.
firebase apphosting:secrets:access \ KEY[@version] \ --project PROJECT_ID	גישה לערך סוד בהתאם לסוד ולגרסה שלו. ברירת המחדל היא גישה לגרסה האחרונה.

פקודות Authentication (ניהול משתמשים)

פקודה	תיאור
auth:export	ייצוא של חשבונות המשתמשים בפרויקט הפעיל לקובץ JSON או CSV. למידע נוסף, אפשר לעיין בדף auth:import ו-auth:export.
auth:import	ייבוא חשבונות המשתמשים מקובץ JSON או CSV לפרויקט הפעיל. פרטים נוספים זמינים בדף auth:import ו-auth:export.

פקודות Cloud Firestore

פקודה	תיאור
firestore:locations	הצגת רשימה של המיקומים הזמינים למסד הנתונים Cloud Firestore.
firestore:databases:create DATABASE_ID	יוצרים מכונה של מסד נתונים במצב מקורי בפרויקט Firebase. הפקודה כוללת את הדגלים הבאים: ‎--location <region name> כדי לציין את מיקום הפריסה של מסד הנתונים. שימו לב שאפשר להריץ את הפקודה firebase firestore:locations כדי להציג את המיקומים הזמינים. חובה. ‎--delete-protection <deleteProtectionState> כדי לאפשר או למנוע מחיקה של מסד הנתונים שצוין. הערכים החוקיים הם ENABLED או DISABLED. ברירת המחדל היא DISABLED. ‎--point-in-time-recovery <PITRState> כדי להגדיר אם שחזור מערכת מנקודה מסוימת בזמן מופעל. הערכים החוקיים הם ENABLED או DISABLED. ברירת המחדל היא DISABLED. זה שינוי אופציונלי.
firestore:databases:list	הצגת רשימה של מסדי הנתונים בפרויקט Firebase.
firestore:databases:get DATABASE_ID	אחזור של הגדרות מסד נתונים של מסד נתונים ספציפי בפרויקט Firebase.
firestore:databases:update DATABASE_ID	עדכון ההגדרות של מסד נתונים מסוים בפרויקט Firebase. חובה להוסיף לפחות דגל אחד. הפקודה כוללת את הדגלים הבאים: ‎--delete-protection <deleteProtectionState> כדי לאפשר או למנוע מחיקה של מסד הנתונים שצוין. הערכים החוקיים הם ENABLED או DISABLED. ברירת המחדל היא DISABLED. ‎--point-in-time-recovery <PITRState> כדי להגדיר אם שחזור מערכת מנקודה מסוימת בזמן מופעל. הערכים החוקיים הם ENABLED או DISABLED. ברירת המחדל היא DISABLED. זה שינוי אופציונלי.
firestore:databases:delete DATABASE_ID	מחיקה של מסד נתונים בפרויקט Firebase.
firestore:indexes	הצגת רשימה של אינדקסים של מסד נתונים בפרויקט Firebase. הפקודה כוללת את הדגל הבא: ‎--database DATABASE_ID כדי לציין את שם מסד הנתונים שלגביו רוצים להציג את האינדקסים. אם לא מציינים את השם, המערכת תציג את האינדקסים של מסד הנתונים שמוגדר כברירת מחדל.
firestore:delete	מחיקה של מסמכים במסד הנתונים של הפרויקט הפעיל. באמצעות CLI אפשר למחוק באופן רקורסיבי את כל המסמכים באוסף. חשוב לזכור שמחיקת נתוני Cloud Firestore באמצעות ה-CLI כרוכה בעלויות קריאה ומחיקה. מידע נוסף זמין במאמר הסבר על חיוב ב-Cloud Firestore. הפקודה כוללת את הדגל הבא: ‎--database DATABASE_ID כדי לציין את שם מסד הנתונים שממנו נמחקים המסמכים. אם לא מציינים את השדה, המסמכים נמחקים ממסד הנתונים שמוגדר כברירת מחדל. זה שינוי אופציונלי.

פקודות Cloud Functions for Firebase

פקודה	תיאור
functions:config:clone	העתקה (cloning) של הסביבה של פרויקט אחר לפרויקט הפעיל ב-Firebase.
functions:config:get	אחזור של ערכי ההגדרות הקיימים של Cloud Functions בפרויקט הפעיל.
functions:config:set	מאגר של ערכי ההגדרות של זמן הריצה של Cloud Functions בפרויקט הפעיל.
functions:config:unset	הסרת ערכים מהגדרות זמן הריצה של הפרויקט הפעיל.
functions:log	קריאת יומנים מ-Cloud Functions שנפרס.

למידע נוסף, עיינו במסמכי התיעוד בנושא הגדרת הסביבה.

פקודות Crashlytics

פקודה	תיאור
crashlytics:mappingfile:generateid \ --resource-file=PATH/TO/ANDROID_RESOURCE.XML	יצירת מזהה קובץ מיפוי ייחודי בקובץ המשאב (XML) של Android שצוין.
crashlytics:mappingfile:upload \ --app=FIREBASE_APP_ID \ --resource-file=PATH/TO/ANDROID_RESOURCE.XML \ PATH/TO/MAPPING_FILE.TXT	העלאת קובץ מיפוי (TXT) תואם Proguard לאפליקציה הזו, ושיוך שלו למזהה קובץ המיפוי שמוצהר בקובץ המשאב (XML) של Android שצוין.
crashlytics:symbols:upload \ --app=FIREBASE_APP_ID \ PATH/TO/SYMBOLS	הכלי יוצר קובץ סמלים תואם ל-Crashlytics לקריסות בספרייה ילידית ב-Android, ומעלה אותו לשרתים של Firebase.

פקודות Data Connect

הפקודות האלה ותרחישי השימוש שלהן מוסברים בפירוט רב יותר במדריך העזר של CLI של Data Connect.

פקודה	תיאור
dataconnect:services:list	הצגת רשימה של כל שירותי Data Connect שנפרסו בפרויקט ב-Firebase.
dataconnect:sql:diff \ SERVICE_ID	בשירות שצוין, מוצגים ההבדלים בין הסכימה המקומית של Data Connect לבין הסכימה של מסד הנתונים ב-Cloud SQL.
dataconnect:sql:migrate \ --force \ SERVICE_ID	העברת הסכימה של מסד הנתונים ב-Cloud SQL כך שתתאים להסכימה המקומית של Data Connect.
dataconnect:sql:grant\ --role=ROLE \ --email=EMAIL \ SERVICE_ID	הקצאת התפקיד ב-SQL לכתובת האימייל של המשתמש או של חשבון השירות שצוינו. לדגל --role, תפקיד ה-SQL להקצאה הוא אחד מהאפשרויות הבאות: owner,‏ writer או reader. בדגל --email, מציינים את כתובת האימייל של המשתמש או חשבון השירות שאליו רוצים להקצות את התפקיד.
dataconnect:sdk:generate	יצירת ערכות SDK מוגדרות לסוגים למחברים של Data Connect.

פקודות Extensions

פקודה	תיאור
ext	הצגת מידע על השימוש בפקודות Firebase Extensions. הצגת רשימה של מכונות התוסף שמותקנות בפרויקט הפעיל.
ext:configure \ EXTENSION_INSTANCE_ID	הגדרה מחדש של ערכי הפרמטרים של מופע התוסף במניפסט של התוסף.
ext:info \ PUBLISHER_ID/EXTENSION_ID	הדפסת מידע מפורט על תוסף.
ext:install \ PUBLISHER_ID/EXTENSION_ID	הוספת מכונה חדשה של תוסף למניפסט של התוסף.
ext:list	הצגת רשימה של כל המופעים של התוסף שמותקנים בפרויקט Firebase. הדפסת מזהה המכונה של כל תוסף.
ext:uninstall \ EXTENSION_INSTANCE_ID	הסרה של מופע של תוסף ממניפסט התוסף.
ext:update \ EXTENSION_INSTANCE_ID	מעדכנת מכונה של תוסף לגרסה האחרונה במניפסט של התוסף.
ext:export	ייצוא כל המופעים של התוספים שהותקנו מהפרויקט למניפסט של התוסף.

Extensions פקודות לבעלי תוכן דיגיטלי

פקודה	תיאור
ext:dev:init	הפונקציה מפעילה את יצירת קוד השלד של תוסף חדש בספרייה הנוכחית.
ext:dev:list \ PUBLISHER_ID	הדפסה של רשימה של כל התוספים שהועלו על ידי בעל תוכן דיגיטלי.
ext:dev:register	רישום פרויקט Firebase כפרויקט של בעל תוספי Chrome.
ext:dev:deprecate \ PUBLISHER_ID/EXTENSION_ID \ VERSION_PREDICATE	הוצאה משימוש של גרסאות התוסף שתואמות לתנאי לגבי הגרסה. תנאי גרסה יכול להיות גרסה אחת (כמו 1.0.0) או טווח גרסאות (כמו >1.0.0). אם לא צוין תנאי גרסה, יבוטל השימוש בכל הגרסאות של התוסף.
ext:dev:undeprecate \ PUBLISHER_ID/EXTENSION_ID \ VERSION_PREDICATE	מבטלים את ההוצאה משימוש של גרסאות התוסף שתואמות לתנאי לגבי הגרסה. תנאי גרסה יכול להיות גרסה אחת (למשל 1.0.0), או טווח גרסאות (למשל >1.0.0). אם לא צוין תנאי גרסה, יבוטל הוצאה משימוש של כל הגרסאות של התוסף.
ext:dev:upload \ PUBLISHER_ID/EXTENSION_ID	העלאת גרסה חדשה של תוסף.
ext:dev:usage \ PUBLISHER_ID	כאן מוצגים מספרי ההתקנות ומדדי השימוש של תוספים שהועלו על ידי בעל תוכן דיגיטלי.

פקודות Hosting

פקודה	תיאור
hosting:disable	הפסקת הצגת תנועה מ-Firebase Hosting בפרויקט הפעיל ב-Firebase. אחרי שתפעילו את הפקודה הזו, תוצג ההודעה 'האתר לא נמצא' בכתובת ה-URL Hosting של הפרויקט.
ניהול של Hosting אתרים
firebase hosting:sites:create \ SITE_ID	יצירת אתר Hosting חדש בפרויקט הפעיל ב-Firebase באמצעות SITE_ID שצוין (אופציונלי) כדי לשייך אפליקציית אינטרנט קיימת ב-Firebase לאתר החדש, מעבירים את הדגל הבא: --app FIREBASE_APP_ID
firebase hosting:sites:delete \ SITE_ID	מחיקת האתר Hosting שצוין לפני המחיקה של האתר, תופיע בקשה לאישור במסוף. (אופציונלי) כדי לדלג על הודעת האישור, מעבירים את הדגלים הבאים: -f או --force
firebase hosting:sites:get \ SITE_ID	אחזור מידע על האתר Hosting שצוין
firebase hosting:sites:list	הצגת רשימה של כל האתרים מסוג Hosting בפרויקט הפעיל ב-Firebase
ניהול של ערוצים עם קטעים מקדימים
firebase hosting:channel:create \ CHANNEL_ID	יצירת ערוץ תצוגה מקדימה חדש באתר Hosting שמוגדר כברירת מחדל באמצעות CHANNEL_ID שצוין הפקודה הזו לא פורסת את הקוד בערוץ.
firebase hosting:channel:delete \ CHANNEL_ID	מחיקה של ערוץ התצוגה המקדימה שצוין לא ניתן למחוק את הערוץ של האתר בשידור חי.
firebase hosting:channel:deploy \ CHANNEL_ID	פריסת התוכן וההגדרות של Hosting בערוץ התצוגה המקדימה שצוין אם ערוץ התצוגה המקדימה עדיין לא קיים, הפקודה הזו יוצרת את הערוץ באתר Hosting שמוגדר כברירת מחדל לפני הפריסה בערוץ.
firebase hosting:channel:list	רשימה של כל הערוצים (כולל הערוץ 'שידור חי') באתר Hosting שמוגדר כברירת מחדל
firebase hosting:channel:open \ CHANNEL_ID	הפונקציה פותחת דפדפן עם כתובת ה-URL של הערוץ שצוין, או מחזירה את כתובת ה-URL אם אי אפשר לפתוח אותה בדפדפן
יצירת עותקים מקודמים של גרסאות
firebase hosting:clone \ SOURCE_SITE_ID:SOURCE_CHANNEL_ID \ TARGET_SITE_ID:TARGET_CHANNEL_ID	הכלי מעתיק את הגרסה האחרונה שפרסמתם בערוץ 'המקור' לערוץ 'היעד' שציינתם הפקודה הזו גם פורסת את הקוד בערוץ 'target' שצוין. אם הערוץ 'target' עדיין לא קיים, הפקודה הזו יוצרת ערוץ תצוגה מקדימה חדש באתר Hosting של היעד לפני הפריסה בערוץ.
firebase hosting:clone \ SOURCE_SITE_ID:@VERSION_ID \ TARGET_SITE_ID:TARGET_CHANNEL_ID	הכלי יוצר עותק (cloning) של הגרסה שצוינה בערוץ 'target' שצוין הפקודה הזו גם פורסת בערוץ 'target' שצוין. אם הערוץ 'target' עדיין לא קיים, הפקודה הזו יוצרת ערוץ תצוגה מקדימה חדש באתר Hosting של היעד לפני הפריסה בערוץ. אפשר למצוא את VERSION_ID במרכז הבקרה Hosting של מסוף Firebase.

פקודות Realtime Database

שימו לב שאפשר ליצור את המכונה הראשונית של Realtime Database שמוגדרת כברירת מחדל במסוף Firebase, או באמצעות תהליך העבודה הכללי של firebase init או תהליך העבודה הספציפי של firebase init database.

אחרי שיוצרים את המכונות, אפשר לנהל אותן כפי שמתואר במאמר ניהול מכונות Realtime Database מרובות.

פקודה	תיאור
database:get	אחזור נתונים ממסד הנתונים של הפרויקט הפעיל והצגתם כ-JSON. תמיכה בהרצת שאילתות על נתונים שנוספו לאינדקס.
database:instances:create	יצירת מכונה של מסד נתונים עם שם מכונה שצוין. מקבלת את האפשרות --location ליצירת מסד נתונים באזור מסוים. שמות האזורים שאפשר להשתמש בהם עם האפשרות הזו מפורטים במאמר בחירת מיקומים לפרויקט. אם לא קיים מכונה של מסד נתונים בפרויקט הנוכחי, תתבקשו להריץ את התהליך firebase init כדי ליצור מכונה.
database:instances:list	הצגת רשימה של כל מכונות מסדי הנתונים בפרויקט הזה. אישור האפשרות --location להצגת מסד נתונים באזור מסוים. שמות האזורים שאפשר להשתמש בהם עם האפשרות הזו מפורטים בקטע בחירת מיקומים לפרויקט.
database:profile	יצירת פרופיל של פעולות במסד הנתונים של הפרויקט הפעיל. למידע נוסף, ראו סוגי הפעולות של Realtime Database.
database:push	דחיפה של נתונים חדשים לרשימה במיקום מסוים במסד הנתונים של הפרויקט הפעיל. מקבלת קלט מקובץ, מ-STDIN או מארגומנט של שורת הפקודה.
database:remove	מחיקה של כל הנתונים במיקום מסוים במסד הנתונים של הפרויקט הפעיל.
database:set	החלפת כל הנתונים במיקום מסוים במסד הנתונים של הפרויקט הפעיל. הפונקציה מקבלת קלט מקובץ, מ-STDIN או מארגומנט של שורת הפקודה.
database:update	ביצוע עדכון חלקי במיקום מסוים במסד הנתונים של הפרויקט הפעיל. מקבלת קלט מקובץ, מ-STDIN או מארגומנט של שורת הפקודה.

פקודות Remote Config

פקודה	תיאור
remoteconfig:versions:list \ --limit NUMBER_OF_VERSIONS	רשימה של עשר הגרסאות האחרונות של התבנית. מציינים את הערך 0 כדי להציג את כל הגרסאות הקיימות, או מעבירים את האפשרות --limit כדי להגביל את מספר הגרסאות שיוחזרו.
remoteconfig:get \ --v, version_number VERSION_NUMBER --o, output FILENAME	הפונקציה מקבלת את התבנית לפי גרסה (ברירת המחדל היא הגרסה האחרונה) ומפיקה טבלה עם השמות והגרסאות של קבוצות הפרמטרים, הפרמטרים והתנאים. אפשר גם לכתוב את הפלט בקובץ מסוים באמצעות -o, FILENAME.
remoteconfig:rollback \ --v, version_number VERSION_NUMBER --force	החזרת התבנית Remote Config לגרסה קודמת מסוימת, או הגדרת ברירת המחדל לגרסה הקודמת (הגרסה הנוכחית -1). אם לא מעבירים את הערך --force, תוצג ההודעה Y/N לפני שממשיכים בחזרה לאחור.