مرجع Firebase CLI

رابط خط فرمان Firebase ( GitHub ) ابزارهای متنوعی را برای مدیریت، مشاهده و استقرار در پروژه‌های فایربیس ارائه می‌دهد.

قبل از استفاده از رابط خط فرمان Firebase ، یک پروژه فایربیس راه‌اندازی کنید .

تنظیم یا به‌روزرسانی رابط خط فرمان (CLI)

نصب رابط خط فرمان Firebase

شما می‌توانید رابط خط فرمان Firebase CLI) را با استفاده از روشی که با سیستم عامل، سطح تجربه و/یا مورد استفاده شما مطابقت دارد، نصب کنید. صرف نظر از نحوه نصب رابط خط فرمان، به همان عملکرد و دستور firebase دسترسی خواهید داشت.

ویندوز، مک او اس، لینوکس

ویندوز

شما می‌توانید Firebase CLI را برای ویندوز با استفاده از یکی از گزینه‌های زیر نصب کنید:

macOS یا لینوکس

شما می‌توانید با استفاده از یکی از گزینه‌های زیر، Firebase CLI را برای macOS یا Linux نصب کنید:

وارد شوید و Firebase CLI را آزمایش کنید

پس از نصب رابط خط فرمان (CLI)، باید احراز هویت کنید. سپس می‌توانید با فهرست کردن پروژه‌های Firebase خود، احراز هویت را تأیید کنید.

1. با استفاده از حساب گوگل خود و با اجرای دستور زیر وارد Firebase شوید:

   firebase login

   این دستور دستگاه محلی شما را به Firebase متصل می‌کند و به شما امکان دسترسی به پروژه‌های Firebase را می‌دهد.

2. با فهرست کردن پروژه‌های Firebase خود، بررسی کنید که CLI به درستی نصب شده و به حساب کاربری شما دسترسی دارد. دستور زیر را اجرا کنید:

   firebase projects:list

   لیست نمایش داده شده باید همان پروژه‌های Firebase فهرست شده در کنسول Firebase باشد.

به آخرین نسخه CLI به‌روزرسانی کنید

به طور کلی، شما می‌خواهید از جدیدترین نسخه Firebase CLI استفاده کنید.

نحوه‌ی به‌روزرسانی نسخه‌ی CLI به سیستم عامل شما و نحوه‌ی نصب CLI بستگی دارد.

رابط خط Firebase حذف نصب کنید

نحوه‌ی حذف نصب CLI به سیستم عامل شما و نحوه‌ی نصب CLI بستگی دارد.

استفاده از رابط خط فرمان (CLI) با سیستم‌های CI

توصیه می‌کنیم هنگام استفاده از رابط خط فرمان (CLI) با سیستم‌های CI، با استفاده از اعتبارنامه‌های پیش‌فرض برنامه (Application Default Credentials) احراز هویت کنید.

(توصیه می‌شود) از اعتبارنامه‌های پیش‌فرض برنامه استفاده کنید

رابط خط فرمان Firebase CLI) در صورت تنظیم شدن، اعتبارنامه‌های پیش‌فرض برنامه (Application Default Credentials) را شناسایی و از آنها استفاده می‌کند. ساده‌ترین راه برای احراز هویت رابط خط فرمان در CI و سایر محیط‌های بدون سر (headless)، تنظیم اعتبارنامه‌های پیش‌فرض برنامه (Application Default Credentials) است.

(قدیمی) از FIREBASE_TOKEN استفاده کنید

روش دیگر، احراز هویت با استفاده از FIREBASE_TOKEN است. این روش نسبت به Application Default Credentials امنیت کمتری دارد و دیگر توصیه نمی‌شود.

1. روی دستگاهی که مرورگر دارد، Firebase CLI را نصب کنید .

2. با اجرای دستور زیر، فرآیند ورود به سیستم را آغاز کنید:

   firebase login:ci

3. به آدرس اینترنتی ارائه شده مراجعه کنید، سپس با استفاده از یک حساب گوگل وارد شوید.

4. یک نشانه به‌روزرسانی جدید چاپ کن. جلسه فعلی CLI تحت تأثیر قرار نخواهد گرفت.

5. توکن خروجی را به روشی امن اما قابل دسترس در سیستم CI خود ذخیره کنید.

6. هنگام اجرای دستورات firebase از این توکن استفاده کنید. می‌توانید از یکی از دو گزینه زیر استفاده کنید:

   • گزینه ۱: توکن را به عنوان متغیر محیطی FIREBASE_TOKEN ذخیره کنید. سیستم شما به طور خودکار از توکن استفاده خواهد کرد.

   • گزینه ۲: تمام دستورات firebase را با پرچم --token TOKEN در سیستم CI خود اجرا کنید.
     این ترتیب اولویت برای بارگذاری توکن است: پرچم، متغیر محیطی، پروژه Firebase مورد نظر.

یک پروژه Firebase را مقداردهی اولیه کنید

بسیاری از وظایف رایج که با استفاده از رابط خط فرمان (CLI) انجام می‌شوند، مانند استقرار در یک پروژه Firebase، به یک دایرکتوری پروژه نیاز دارند. شما با استفاده از دستور firebase init یک دایرکتوری پروژه ایجاد می‌کنید. دایرکتوری پروژه معمولاً همان دایرکتوری ریشه کنترل منبع شماست و پس از اجرای firebase init ، این دایرکتوری حاوی یک فایل پیکربندی firebase.json است.

برای مقداردهی اولیه یک پروژه جدید Firebase، دستور زیر را از داخل دایرکتوری برنامه خود اجرا کنید:

firebase init

{
  "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"
    ]
  }
}

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

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

firebase use --add

شما می‌توانید با ارسال فلگ --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

رابط خط فرمان Firebase CLI) مدیریت استقرار کد و دارایی‌ها را در پروژه فایربیس شما بر عهده دارد، از جمله:

• نسخه‌های جدید سایت‌های 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، از partial deployment استفاده کنید .

تداخلات استقرار برای قوانین امنیتی

برای Firebase Realtime Database ، Cloud Storage for Firebase و Cloud Firestore ، می‌توانید قوانین امنیتی را یا در دایرکتوری پروژه محلی خود یا در کنسول Firebase تعریف کنید.

گزینه دیگر برای جلوگیری از تداخل در استقرار، استفاده از استقرار جزئی و تعریف قوانین فقط در کنسول Firebase است.

سهمیه‌های اعزام

این امکان وجود دارد (هرچند بعید است) که از سهمیه‌ای که نرخ یا حجم عملیات استقرار Firebase شما را محدود می‌کند، تجاوز کنید. برای مثال، هنگام استقرار تعداد بسیار زیادی از توابع، ممکن است پیام خطای HTTP 429 Quota دریافت کنید. برای حل چنین مشکلاتی، سعی کنید از استقرار جزئی استفاده کنید .

یک استقرار را به عقب برگردانید

شما می‌توانید با انتخاب عمل Rollback برای نسخه مورد نظر، یک نسخه Firebase Hosting را از صفحه Firebase Hosting پروژه خود به نسخه قبلی برگردانید.

در حال حاضر امکان بازگرداندن نسخه‌های قوانین امنیتی برای Firebase Realtime Database ، Cloud Storage for Firebase یا Cloud Firestore وجود ندارد.

سرویس‌های خاص Firebase را مستقر کنید

اگر فقط می‌خواهید سرویس‌ها یا ویژگی‌های خاصی از Firebase را مستقر کنید، می‌توانید از یک لیست جدا شده با کاما در یک پرچم در دستور firebase deploy استفاده کنید. به عنوان مثال، دستور زیر محتوای Firebase Hosting و قوانین امنیتی Cloud Storage را مستقر می‌کند.

firebase deploy --only hosting,storage

جدول زیر سرویس‌ها و ویژگی‌های موجود برای استقرار جزئی را فهرست می‌کند. نام‌های موجود در پرچم‌ها (flags) با کلیدهای موجود در فایل پیکربندی firebase.json شما مطابقت دارند.

استقرار توابع خاص

هنگام استقرار توابع، می‌توانید توابع خاصی را هدف قرار دهید. برای مثال:

firebase deploy --only functions:function1

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

گزینه دیگر، گروه‌بندی توابع در گروه‌های export در فایل /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

حذف توابع

رابط خط فرمان 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

تنظیم وظایف اسکریپت‌شده قبل و بعد از استقرار

شما می‌توانید اسکریپت‌های shell را به دستور firebase deploy متصل کنید تا وظایف predeploy یا postdeploy را انجام دهید. برای مثال، یک اسکریپت predeploy می‌تواند کد TypeScript را به جاوا اسکریپت transpile کند، و یک قلاب postdeploy می‌تواند مدیران را از محتوای جدید سایت که به Firebase Hosting ارسال می‌شود، مطلع کند.

برای تنظیم قلاب‌های predeploy یا postdeploy، اسکریپت‌های bash را به فایل پیکربندی firebase.json خود اضافه کنید. می‌توانید اسکریپت‌های مختصر را مستقیماً در فایل firebase.json تعریف کنید، یا می‌توانید به فایل‌های دیگری که در دایرکتوری پروژه شما هستند، ارجاع دهید.

برای مثال، اسکریپت زیر عبارت firebase.json برای یک وظیفه postdeploy است که پس از استقرار موفقیت‌آمیز به Firebase Hosting یک پیام Slack ارسال می‌کند.

"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 تمام وظایف predeploy و postdeploy تعریف شده در فایل firebase.json شما را فعال می‌کند. برای اجرای فقط وظایف مرتبط با یک سرویس خاص Firebase، از دستورات استقرار جزئی استفاده کنید .

هر دو قلاب predeploy و postdeploy خروجی استاندارد و جریان‌های خطای اسکریپت‌ها را در ترمینال چاپ می‌کنند. برای موارد خرابی، به موارد زیر توجه کنید:

• اگر یک قلاب پیش از استقرار مطابق انتظار تکمیل نشود، استقرار لغو می‌شود.
• اگر به هر دلیلی استقرار با شکست مواجه شود، قلاب‌های پس از استقرار فعال نمی‌شوند.

متغیرهای محیطی

در اسکریپت‌هایی که در قلاب‌های predeploy و postdeploy اجرا می‌شوند، متغیرهای محیطی زیر در دسترس هستند:

• $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

دستورات مدیریت پروژه

استقرار و توسعه محلی

این دستورات به شما امکان می‌دهند سایت Firebase Hosting خود را مستقر کرده و با آن تعامل داشته باشید.

دستورات App Distribution

دستورات App Hosting

دستورات Authentication (مدیریت کاربر)

دستورات Cloud Firestore

Cloud Functions for Firebase

For more information, refer to the environment configuration documentation .

Crashlytics commands

Data Connect commands

These commands and their use cases are covered in more detail in the Data Connect CLI reference guide .

Extensions commands

Extensions publisher commands

Hosting commands

Realtime Database commands

Note that you can create your initial, default Realtime Database instance in the Firebase console or by using the general firebase init workflow or the specific firebase init database flow.

Once instances are created, you can manage them as discussed in Manage multiple Realtime Database instances .

Remote Config commands