مرجع Firebase CLI

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

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

CLI را راه اندازی یا به روز کنید

Firebase CLI را نصب کنید

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

Windows macOS Linux

ویندوز

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

macOS یا Linux

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

وارد شوید و Firebase CLI را تست کنید

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

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

   firebase login

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

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

   firebase projects:list

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

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

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

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

از CLI با سیستم های CI استفاده کنید

Firebase CLI برای تکمیل احراز هویت به مرورگر نیاز دارد، اما CLI کاملاً با CI و سایر محیط‌های بدون هد سازگار است.

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

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 می رساند. در طول اولیه سازی پروژه، Firebase CLI از شما می خواهد کارهای زیر را تکمیل کنید:

• محصولات Firebase مورد نظر را برای راه اندازی در پروژه Firebase خود انتخاب کنید.

  این مرحله از شما می‌خواهد تنظیماتی را برای فایل‌های خاص برای محصولات انتخاب شده تنظیم کنید. برای جزئیات بیشتر در مورد این تنظیمات، به مستندات محصول خاص (به عنوان مثال، Hosting ) مراجعه کنید. توجه داشته باشید که همیشه می‌توانید firebase init بعداً برای راه‌اندازی محصولات Firebase بیشتری اجرا کنید.

• یک پروژه Firebase پیش فرض را انتخاب کنید.

  این مرحله دایرکتوری پروژه فعلی را با یک پروژه Firebase مرتبط می کند تا دستورات خاص پروژه (مانند firebase deploy ) در برابر پروژه Firebase مناسب اجرا شوند.

  همچنین می توان چندین پروژه Firebase (مانند یک پروژه مرحله بندی و یک پروژه تولید) را با یک فهرست پروژه مرتبط کرد .

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

• یک فایل پیکربندی firebase.json که پیکربندی پروژه شما را فهرست می کند.

• یک فایل .firebaserc که نام مستعار پروژه شما را ذخیره می کند.

فایل firebase.json

دستور firebase init یک فایل پیکربندی firebase.json در ریشه دایرکتوری پروژه شما ایجاد می کند.

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

شما می توانید اکثر گزینه های Firebase Hosting را مستقیماً در فایل firebase.json پیکربندی کنید. با این حال، برای سایر سرویس‌های Firebase که می‌توانند با Firebase CLI مستقر شوند ، دستور firebase init فایل‌های خاصی را ایجاد می‌کند که در آن می‌توانید تنظیماتی را برای آن سرویس‌ها تعریف کنید، مانند فایل index.js برای Cloud Functions . همچنین می‌توانید قلاب‌های predeploy یا postdeploy را در فایل firebase.json تنظیم کنید.

در صورت انتخاب Firebase Hosting ، Cloud Firestore و Cloud Functions for Firebase (با انتخاب منبع TypeScript و گزینه‌های lint) در زیر یک نمونه فایل firebase.json با تنظیمات پیش‌فرض است.

{
  "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 برای نادیده گرفتن مشخص می‌کند. این مانع از استقرار فایل‌های اضافی در backend می‌شود که می‌توانند اندازه داده‌های استقرار شما را افزایش دهند.

لیست فایل‌هایی که به‌طور پیش‌فرض نادیده گرفته شده‌اند، با فرمت JSON نشان داده شده است:

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

اگر مقادیر سفارشی خود را برای ignore در firebase.json اضافه می‌کنید، مطمئن شوید که لیست فایل‌های نشان‌داده شده در بالا را نگه دارید (یا در صورت وجود نداشت، اضافه کنید).

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

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

نام مستعار پروژه را اضافه کنید

هنگامی که یک پروژه Firebase را در حین تنظیم اولیه پروژه انتخاب می کنید، به پروژه به طور خودکار نام مستعار default اختصاص داده می شود. با این حال، برای اینکه اجازه دهید دستورات خاص پروژه در برابر یک پروژه Firebase متفاوت اجرا شوند، اما همچنان از همان فهرست پروژه استفاده کنند، دستور زیر را از داخل فهرست پروژه خود اجرا کنید:

firebase use --add

این دستور از شما می خواهد که پروژه Firebase دیگری را انتخاب کرده و پروژه را به عنوان نام مستعار اختصاص دهید. تخصیص مستعار در یک فایل .firebaserc در دایرکتوری پروژه شما نوشته می شود.

از نام مستعار پروژه استفاده کنید

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

می‌توانید با ارسال پرچم --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 شما مدیریت می کند، از جمله:

• نسخه های جدید سایت های 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 دریافت کنید. برای حل چنین مسائلی، از استقرار جزئی استفاده کنید.

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

می‌توانید با انتخاب اکشن 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

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

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

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

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

حذف توابع

Firebase CLI از دستورات و گزینه های زیر برای حذف توابع مستقر شده قبلی پشتیبانی می کند:

• تمام توابعی را که با نام مشخص شده در همه مناطق مطابقت دارند حذف می کند:

  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 متصل کنید تا وظایف پیش از گسترش یا پس از استقرار را انجام دهید. برای مثال، یک اسکریپت predeploy می‌تواند کد TypeScript را به جاوا اسکریپت انتقال دهد، و یک hook 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

برای اطلاعات بیشتر، به مستندات پیکربندی محیط مراجعه کنید.

دستورات Crashlytics

دستورات Data Connect

این دستورات و موارد استفاده از آنها با جزئیات بیشتری در راهنمای مرجع Data Connect CLI پوشش داده شده است.

دستورات Extensions

دستورات ناشر Extensions

دستورات Hosting

دستورات Realtime Database

توجه داشته باشید که می توانید نمونه اولیه و پیش فرض Realtime Database خود را در کنسول Firebase یا با استفاده از گردش کار عمومی firebase init یا جریان firebase init database ایجاد کنید.

پس از ایجاد نمونه ها ، می توانید آنها را همانطور که در مدیریت چندین نمونه Realtime Database بحث شده است ، مدیریت کنید.

دستورات Remote Config

یک پروژه Firebase را آغاز کنید

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

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

firebase init

فرمان firebase init شما را از طریق تنظیم دایرکتوری پروژه و برخی از محصولات Firebase خود قدم می گذارد. در حین اولیه سازی پروژه ، Firebase CLI از شما می خواهد که کارهای زیر را انجام دهید:

• محصولات Firebase مورد نظر را برای تنظیم در پروژه Firebase خود انتخاب کنید.

  این مرحله باعث می شود که تنظیمات پرونده های خاص برای محصولات انتخاب شده را تنظیم کنید. برای اطلاعات بیشتر در مورد این تنظیمات ، به مستندات محصول خاص (به عنوان مثال Hosting ) مراجعه کنید. توجه داشته باشید که همیشه می توانید firebase init بعداً اجرا کنید تا محصولات Firebase بیشتری را تنظیم کنید.

• یک پروژه پیش فرض Firebase را انتخاب کنید.

  این مرحله دایرکتوری پروژه فعلی را با یک پروژه Firebase مرتبط می کند تا دستورات خاص پروژه (مانند firebase deploy ) در برابر پروژه مناسب Firebase اجرا شود.

  همچنین می توان چندین پروژه Firebase (مانند یک پروژه مرحله بندی و یک پروژه تولید) را با همان دایرکتوری پروژه مرتبط کرد .

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

• یک پرونده پیکربندی firebase.json که پیکربندی پروژه شما را لیست می کند.

• یک پرونده .firebaserc که نام مستعار پروژه شما را ذخیره می کند.

پرونده firebase.json

فرمان firebase init یک پرونده پیکربندی firebase.json را در ریشه فهرست پروژه شما ایجاد می کند.

پرونده firebase.json لازم است دارایی ها را با Firebase CLI مستقر کند زیرا مشخص می کند کدام پرونده ها و تنظیمات از فهرست پروژه شما به پروژه Firebase شما اعزام شده است. از آنجا که برخی از تنظیمات را می توان در فهرست پروژه شما یا کنسول Firebase تعریف کرد ، حتماً هرگونه درگیری احتمالی استقرار را حل کنید.

می توانید بیشتر گزینه های Firebase Hosting را مستقیماً در پرونده firebase.json پیکربندی کنید. با این حال ، برای سایر خدمات Firebase که می توانند با Firebase CLI مستقر شوند ، دستور firebase init پرونده های خاصی را ایجاد می کند که می توانید تنظیمات مربوط به آن خدمات را تعریف کنید ، مانند یک پرونده index.js برای Cloud Functions . همچنین می توانید قلاب های Premeploy یا Postdeploy را در پرونده 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 Files برای نادیده گرفتن در استقرار

در زمان استقرار عملکرد ، CLI به طور خودکار لیستی از پرونده های موجود در فهرست functions را برای نادیده گرفتن مشخص می کند. این امر مانع از استقرار در پرونده های بیرونی با پس زمینه می شود که می تواند اندازه داده استقرار شما را افزایش دهد.

لیست پرونده های نادیده گرفته شده به طور پیش فرض ، که در قالب JSON نشان داده شده است ،:

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

اگر مقادیر سفارشی خود را برای ignore در firebase.json اضافه می کنید ، مطمئن شوید که لیست پرونده های نشان داده شده در بالا را نگه دارید (یا اضافه کنید ، اگر از دست رفته باشد).

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

می توانید چندین پروژه Firebase را با همان فهرست پروژه مرتبط کنید. به عنوان مثال ، شما ممکن است بخواهید از یک پروژه Firebase برای مرحله بندی و دیگری برای تولید استفاده کنید. با استفاده از محیط های مختلف پروژه ، می توانید قبل از استقرار در تولید ، تغییرات را تأیید کنید. دستور firebase use به شما امکان می دهد بین نام مستعار و همچنین ایجاد نام مستعار جدید جابجا شوید.

یک پروژه نام مستعار اضافه کنید

هنگامی که شما یک پروژه Firebase را در حین اولیه سازی پروژه انتخاب می کنید ، این پروژه به طور خودکار نام مستعار default را اختصاص می دهد. با این حال ، برای اجازه دادن به دستورات خاص پروژه در برابر یک پروژه Firebase متفاوت اما هنوز هم از همان دایرکتوری پروژه استفاده کنید ، دستور زیر را از درون فهرست پروژه خود اجرا کنید:

firebase use --add

این دستور شما را وادار می کند تا یک پروژه Firebase دیگری را انتخاب کرده و پروژه را به عنوان نام مستعار اختصاص دهید. تکالیف Alias ​​به یک پرونده .firebaserc در فهرست پروژه شما نوشته شده است.

از نام مستعار پروژه استفاده کنید

برای استفاده از نام مستعار پروژه Firebase اختصاص داده شده ، هر یک از دستورات زیر را از درون فهرست پروژه خود اجرا کنید.

شما می توانید با عبور از پرچم --project با هر دستور CLI ، آنچه را که به عنوان پروژه فعال در حال حاضر استفاده می شود ، نادیده بگیرید. به عنوان نمونه: شما می توانید CLI خود را برای اجرای در برابر یک پروژه Firebase که نام مستعار staging تعیین کرده اید ، تنظیم کنید. اگر می خواهید یک فرمان واحد را در برابر پروژه Firebase که به عنوان Alias prod اختصاص داده اید اجرا کنید ، می توانید به عنوان مثال ، firebase deploy --project=prod اجرا کنید.

کنترل منبع و نام مستعار پروژه

به طور کلی ، شما باید پرونده .firebaserc خود را در کنترل منبع بررسی کنید تا به تیم خود اجازه دهید نام مستعار پروژه را به اشتراک بگذارد. با این حال ، برای پروژه های منبع باز یا الگوهای استارت ، به طور کلی نباید در پرونده .firebaserc خود را بررسی کنید.

اگر یک پروژه توسعه ای دارید که فقط برای استفاده شما است ، می توانید پرچم --project را با هر دستور منتقل کنید یا firebase use PROJECT_ID بدون اختصاص نام مستعار به پروژه Firebase استفاده کنید.

پروژه Firebase خود را به صورت محلی سرو و آزمایش کنید

شما می توانید قبل از استقرار در تولید ، پروژه Firebase خود را در URL های میزبان محلی مشاهده و آزمایش کنید. اگر فقط می خواهید ویژگی های SELECT را آزمایش کنید ، می توانید از یک لیست جدا از کاما در پرچم در دستور 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 شما ، از جمله:

• نسخه های جدید سایت های 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 پروژه خود برگردانید.

در حال حاضر امکان انتشار نسخه های قوانین امنیتی برای Firebase Realtime Database ، Cloud Storage for Firebase یا Cloud Firestore امکان پذیر نیست.

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

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

firebase deploy --only hosting,storage

در جدول زیر خدمات و ویژگی های موجود برای استقرار جزئی ذکر شده است. نام های موجود در پرچم ها با کلیدهای موجود در پرونده پیکربندی firebase.json شما مطابقت دارند.

توابع خاص را مستقر کنید

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

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

توابع را حذف کنید

Firebase CLI از دستورات و گزینه های زیر برای حذف توابع قبلاً مستقر پشتیبانی می کند:

• تمام توابع مطابق با نام مشخص شده در همه مناطق را حذف می کند:

  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

وظایف اسکریپت شده پیش از کار و Postdeploy را تنظیم کنید

می توانید اسکریپت های پوسته را برای انجام وظایف از پیش استخدام یا postdeploy به دستور firebase deploy متصل کنید. به عنوان مثال ، یک اسکریپت از پیش برنامه می تواند کد Typescript را به JavaScript منتقل کند ، و یک قلاب Postdeploy می تواند به مدیران از محتوای سایت جدید استقرار در Firebase Hosting اطلاع دهد.

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

هر دو قلاب 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 FLAG. دستورات زیر از پرچم --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 (user management) commands

Cloud Firestore commands

Cloud Functions for Firebase commands

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