Firebase CLI referansı

Firebase CLI (GitHub), Firebase projelerini yönetmek, görüntülemek ve projelere dağıtmak için çeşitli araçlar sağlar.

Firebase CLI'yi kullanmadan önce bir Firebase projesi oluşturun.

KSA'yı ayarlama veya güncelleme

Firebase CLI'yi yükleme

Firebase CLI'yi işletim sisteminizle, deneyim seviyenizle ve/veya kullanım alanınızla eşleşen bir yöntem kullanarak yükleyebilirsiniz. CLI'yi nasıl yüklediğinizden bağımsız olarak aynı işlevlere ve firebase komutuna erişebilirsiniz.

Windows macOS Linux

Windows

Windows için Firebase CLI'yi aşağıdaki seçeneklerden birini kullanarak yükleyebilirsiniz:

macOS veya Linux

macOS veya Linux için Firebase CLI'yi aşağıdaki seçeneklerden birini kullanarak yükleyebilirsiniz:

Giriş yapıp Firebase CLI'yi test etme

CLI'yi yükledikten sonra kimlik doğrulamanız gerekir. Ardından, Firebase projelerinizi listeleyerek kimlik doğrulamayı onaylayabilirsiniz.

1. Aşağıdaki komutu çalıştırarak Google Hesabınızı kullanarak Firebase'e giriş yapın:

   firebase login

   Bu komut, yerel makinenizi Firebase'e bağlar ve Firebase projelerinize erişim izni verir.

2. Firebase projelerinizi listeleyerek CLI'nin düzgün şekilde yüklenip yüklenmediğini ve hesabınıza erişip erişmediğini test edin. Aşağıdaki komutu çalıştırın:

   firebase projects:list

   Gösterilen liste, Firebase konsolunda listelenen Firebase projeleriyle aynı olmalıdır.

KSA'yı en son sürüme güncelleyin

Genellikle en güncel Firebase CLI sürümünü kullanmak istersiniz.

CLI sürümünü nasıl güncelleyeceğiniz, işletim sisteminize ve CLI'yi nasıl yüklediğinize bağlıdır.

KSA'yı CI sistemleriyle kullanma

Firebase CLI'nin kimlik doğrulamayı tamamlaması için bir tarayıcı gerekir ancak CLI, CI ve diğer headless ortamlarla tam uyumludur.

1. Tarayıcı bulunan bir makineye Firebase CLI'yi yükleyin.

2. Aşağıdaki komutu çalıştırarak oturum açma işlemini başlatın:

   firebase login:ci

3. Sağlanan URL'yi ziyaret edin ve ardından bir Google Hesabı kullanarak giriş yapın.

4. Yeni bir yenileme jetonu yazdırın. Mevcut CLI oturumu etkilenmez.

5. Çıkış jetonunu CI sisteminizde güvenli ancak erişilebilir bir şekilde saklayın.

6. firebase komutlarını çalıştırırken bu jetonu kullanın. Aşağıdaki iki seçenekten birini kullanabilirsiniz:

   • 1. Seçenek: Jetonu FIREBASE_TOKEN ortam değişkeni olarak depolayın. Sisteminiz jetonu otomatik olarak kullanır.

   • 2. Seçenek: Tüm firebase komutlarını CI sisteminizde --token TOKEN işaretiyle çalıştırın.
     Jeton yükleme için öncelik sırası şu şekildedir: işaret, ortam değişkeni, istenen Firebase projesi.

Firebase projesini ilk kullanıma hazırlama

CLI kullanılarak gerçekleştirilen birçok yaygın görev (ör. Firebase projesine dağıtma) için proje dizini gerekir. firebase init komutunu kullanarak bir proje dizini oluşturursunuz. Proje dizini genellikle kaynak denetimi kök dizininizle aynı dizindir ve firebase init çalıştırıldıktan sonra dizinde bir firebase.json yapılandırma dosyası bulunur.

Yeni bir Firebase projesini başlatmak için uygulamanızın dizininden aşağıdaki komutu çalıştırın:

firebase init

firebase init komutu, proje dizininizi ve bazı Firebase ürünlerini ayarlama sürecinde size yol gösterir. Projenin başlatılması sırasında Firebase CLI sizden aşağıdaki görevleri tamamlamanızı ister:

• Firebase projenizde ayarlamak istediğiniz Firebase ürünlerini seçin.

  Bu adımda, seçili ürünler için belirli dosyalar için yapılandırmalar belirlemeniz istenir. Bu yapılandırmalar hakkında daha fazla bilgi için ilgili ürünün dokümanlarına (ör. Hosting) bakın. Daha fazla Firebase ürünü ayarlamak için dilediğiniz zaman firebase init'ı çalıştırabileceğinizi unutmayın.

• Varsayılan bir Firebase projesi seçin.

  Bu adımda, projeye özgü komutların (firebase deploy gibi) uygun Firebase projesinde çalıştırılması için geçerli proje dizini bir Firebase projesiyle ilişkilendirilir.

  Aynı proje diziniyle birden fazla Firebase projesini (ör. hazırlık projesi ve üretim projesi) ilişkilendirmek de mümkündür.

İlklendirmenin sonunda Firebase, yerel uygulama dizininizin kökünde aşağıdaki iki dosyayı otomatik olarak oluşturur:

• Proje yapılandırmanızı listeleyen bir firebase.json yapılandırma dosyası.

• Projenizin takma adlarını depolayan bir .firebaserc dosyası.

firebase.json dosyası

firebase init komutu, proje dizinizin kökünde bir firebase.json yapılandırma dosyası oluşturur.

firebase.json dosyası, proje dizininizdeki hangi dosya ve ayarların Firebase projenize dağıtılacağını belirttiği için öğeleri Firebase CLI ile dağıtmak için gereklidir. Bazı ayarlar proje dizininizde veya Firebase konsolunda tanımlanabileceğinden, olası yayınlama çakışmalarını çözdüğünüzden emin olun.

Çoğu Firebase Hosting seçeneğini doğrudan firebase.json dosyasında yapılandırabilirsiniz. Ancak firebase init komutu, Firebase CLI ile dağıtılabilen diğer Firebase hizmetleri için bu hizmetlerle ilgili ayarları tanımlayabileceğiniz belirli dosyalar oluşturur (ör. Cloud Functions için bir index.js dosyası). firebase.json dosyasında yayından önce veya yayından sonra kancaları da ayarlayabilirsiniz.

Aşağıda, başlatma sırasında Firebase Hosting, Cloud Firestore ve Cloud Functions for Firebase'ı (TypeScript kaynağı ve lint seçenekleri seçili olarak) seçerseniz varsayılan ayarlara sahip örnek bir firebase.json dosyası verilmiştir.

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

Varsayılan olarak firebase.json kullanılır ancak alternatif bir yapılandırma dosyası belirtmek için --config PATH işaretini iletebilirsiniz.

Birden fazla Cloud Firestore veritabanı için yapılandırma

firebase init dosyasını çalıştırdığınızda, firebase.json dosyanız yukarıda gösterildiği gibi projenizin varsayılan veritabanına karşılık gelen tek bir firestore anahtarı içerir.

Projenizde birden fazla Cloud Firestore veritabanı varsa her veritabanı ile farklı Cloud Firestore Security Rules ve veritabanı dizini kaynak dosyalarını ilişkilendirmek için firebase.json dosyanızı düzenleyin. Dosyayı, her veritabanı için bir giriş içeren bir JSON dizisiyle değiştirin.

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

Dağıtımda yoksayılacak Cloud Functions dosyası

KSA, işlev dağıtımı sırasında functions dizininde yoksayılacak dosyaların listesini otomatik olarak belirtir. Bu, arka uçta dağıtımınızın veri boyutunu artırabilecek ek dosyaların dağıtılmasını önler.

Varsayılan olarak yoksayılan dosyaların JSON biçiminde gösterilen listesi şunlardır:

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

firebase.json içinde ignore için kendi özel değerlerinizi eklerseniz yukarıda gösterilen dosya listesini koruduğunuzdan (veya eksikse eklediğinizden) emin olun.

Proje takma adlarını yönetme

Aynı proje diziniyle birden fazla Firebase projesini ilişkilendirebilirsiniz. Örneğin, hazırlık için bir Firebase projesi, üretim için başka bir Firebase projesi kullanmak isteyebilirsiniz. Farklı proje ortamları kullanarak değişiklikleri üretime dağıtmadan önce doğrulayabilirsiniz. firebase use komutu, takma adlar arasında geçiş yapmanıza ve yeni takma adlar oluşturmanıza olanak tanır.

Proje takma adı ekleme

Proje başlatma sırasında bir Firebase projesi seçtiğinizde projeye otomatik olarak default takma adı atanır. Ancak projeye özgü komutların farklı bir Firebase projesinde çalıştırılmasına izin vermek ancak yine de aynı proje dizinini kullanmak için proje dizininizden aşağıdaki komutu çalıştırın:

firebase use --add

Bu komut, başka bir Firebase projesi seçmenizi ve projeyi takma ad olarak atamanız ister. Takma ad atamaları, proje dizininizdeki bir .firebaserc dosyasına yazılır.

Proje takma adlarını kullanma

Atanmış Firebase proje takma adlarını kullanmak için proje dizininizden aşağıdaki komutlardan birini çalıştırın.

Herhangi bir CLI komutuyla --project işaretini ileterek şu anda etkin proje olarak kullanılan projeyi geçersiz kılabilirsiniz. Örneğin: CLI'nizi, staging takma adını atadığınız bir Firebase projesinde çalıştıracak şekilde ayarlayabilirsiniz. prod takma adını atadığınız Firebase projesine karşı tek bir komut çalıştırmak istiyorsanız örneğin firebase deploy --project=prod komutunu çalıştırabilirsiniz.

Kaynak denetimi ve proje takma adları

Genel olarak, ekibinizin proje takma adlarını paylaşmasına izin vermek için .firebaserc dosyanızı kaynak denetimine eklemeniz gerekir. Ancak açık kaynak projeler veya başlangıç şablonları için genellikle .firebaserc dosyanızı kontrol etmemeniz gerekir.

Yalnızca sizin kullanabileceğiniz bir geliştirme projeniz varsa her komutla birlikte --project işaretini iletebilir veya Firebase projesine bir takma ad atamadan firebase use PROJECT_ID'i çalıştırabilirsiniz.

Firebase projenizi yerel olarak yayınlama ve test etme

Firebase projenizi üretime dağıtmadan önce yerel olarak barındırılan URL'lerde görüntüleyebilir ve test edebilirsiniz. Yalnızca belirli özellikleri test etmek istiyorsanız firebase serve komutunda virgülle ayrılmış bir liste kullanabilirsiniz.

Aşağıdaki görevlerden birini yapmak istiyorsanız yerel proje dizininizin kökünden aşağıdaki komutu çalıştırın:

• Firebase'da barındırılan uygulamanızın statik içeriğini görüntüleyin.
• Firebase Hosting için dinamik içerik oluşturmak amacıyla Cloud Functions'ü kullanıyorsanız ve yerel bir URL'de Hosting'i taklit etmek için üretim (dağıtılmış) HTTP işlevlerinizi kullanmak istiyorsanız.

firebase serve --only hosting

Yerel HTTP işlevlerini kullanarak projenizi taklit etme

Projenizi yerel HTTP işlevlerini kullanarak taklit etmek için proje dizininizden aşağıdaki komutlardan birini çalıştırın.

• HTTP işlevlerini ve barındırmayı yerel URL'lerde test etmek için aşağıdaki komutlardan birini kullanın:

  firebase serve

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

• Yalnızca HTTP işlevlerini taklit etmek için aşağıdaki komutu kullanın:

  firebase serve --only functions

Diğer yerel cihazlardan test etme

Varsayılan olarak firebase serve yalnızca localhost'ten gelen isteklere yanıt verir. Bu, barındırılan içeriğinize bilgisayarınızın web tarayıcısından erişebileceğiniz ancak ağınızdaki diğer cihazlardan erişemeyeceğiniz anlamına gelir. Diğer yerel cihazlardan test etmek istiyorsanız --host işaretini kullanın. Örneğin:

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

Firebase projesine dağıtma

Firebase CLI, aşağıdakiler dahil olmak üzere Firebase projenize kod ve öğe dağıtımını yönetir:

• Firebase Hosting sitelerinizdeki yeni yayınlar
• Yeni, güncellenmiş veya mevcut Cloud Functions for Firebase
• Firebase Data Connect için yeni veya güncellenmiş şemalar ve bağlayıcılar
• Firebase Realtime Database için kurallar
• Cloud Storage for Firebase için kurallar
• Cloud Firestore için kurallar
• Cloud Firestore için dizinler

Bir Firebase projesine dağıtmak için proje dizininizden aşağıdaki komutu çalıştırın:

firebase deploy

İsterseniz dağıtımlarınızın her birine yorum ekleyebilirsiniz. Bu yorum, projenizin Firebase Hostingsayfasındaki diğer dağıtım bilgileriyle birlikte gösterilir. Örneğin:

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

firebase deploy komutunu kullanırken aşağıdakilere dikkat edin:

• Bir proje dizininden kaynak dağıtmak için proje dizininde firebase.json dosyası bulunmalıdır. Bu dosya, firebase init komutu tarafından sizin için otomatik olarak oluşturulur.

• Varsayılan olarak firebase deploy, proje dizininizdeki tüm dağıtılabilir kaynaklar için bir sürüm oluşturur. Belirli Firebase hizmetlerini veya özelliklerini dağıtmak için kısmi dağıtımı kullanın.

Güvenlik kurallarıyla ilgili dağıtım anlaşmazlıkları

Firebase Realtime Database, Cloud Storage for Firebase ve Cloud Firestore için güvenlik kurallarını yerel proje dizininizde veya Firebase konsolunda tanımlayabilirsiniz.

Dağıtım çakışmalarını önlemek için kısmi dağıtımı kullanmak ve yalnızca Firebase konsolunda kural tanımlamak da bir seçenektir.

Dağıtım kotaları

Firebase dağıtım işlemlerinizin hızını veya hacmini sınırlayan bir kotayı aşmanız mümkündür (ancak bu olasılık düşüktür). Örneğin, çok sayıda işlev dağıtırken HTTP 429 Quotahata mesajı alabilirsiniz. Bu tür sorunları çözmek için kısmi dağıtımı kullanmayı deneyin.

Dağıtımı geri alma

İstediğiniz sürüm için Geri alma işlemini seçerek projenizin Firebase Hosting sayfasından Firebase Hosting dağıtımını geri alabilirsiniz.

Şu anda Firebase Realtime Database, Cloud Storage for Firebase veya Cloud Firestore için güvenlik kurallarının sürümlerini geri almak mümkün değildir.

Belirli Firebase hizmetlerini dağıtma

Yalnızca belirli Firebase hizmetlerini veya özelliklerini dağıtmak istiyorsanız firebase deploy komutundaki bir işarette virgül ile ayrılmış bir liste kullanabilirsiniz. Örneğin, aşağıdaki komut Firebase Hosting içerik ve Cloud Storage güvenlik kurallarını dağıtır.

firebase deploy --only hosting,storage

Aşağıdaki tabloda, kısmi dağıtım için kullanılabilen hizmetler ve özellikler listelenmiştir. İşaretçilerdeki adlar, firebase.json yapılandırma dosyanızdaki anahtarlara karşılık gelir.

Belirli işlevleri dağıtma

İşlev dağıtırken belirli işlevleri hedefleyebilirsiniz. Örneğin:

firebase deploy --only functions:function1

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

Diğer bir seçenek de /functions/index.js dosyanızda işlevleri dışa aktarma grupları halinde gruplandırmaktır. Gruplandırma işlevleri, tek bir komut kullanarak birden fazla işlev dağıtmanıza olanak tanır.

Örneğin, bir groupA ve groupB tanımlamak için aşağıdaki işlevleri yazabilirsiniz:

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

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

Bu örnekte, groupB'daki işlevleri özel olarak tanımlayan ek işlevler ayrı bir functions/groupB.js dosyasında yer almaktadır. Örneğin:

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

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

Bu örnekte, proje dizininizden aşağıdaki komutu çalıştırarak tüm groupA işlevlerini dağıtabilirsiniz:

firebase deploy --only functions:groupA

Alternatif olarak, aşağıdaki komutu çalıştırarak bir gruptaki belirli bir işlevi hedefleyebilirsiniz:

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

İşlevleri silin

Firebase CLI, daha önce dağıtılan işlevleri silmek için aşağıdaki komutları ve seçenekleri destekler:

• Belirtilen adla eşleşen tüm işlevleri tüm bölgelerde siler:

  firebase functions:delete FUNCTION-1_NAME

• Varsayılan olmayan bir bölgede çalışan belirli bir işlevi siler:

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

• Birden fazla işlevi siler:

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

• Belirtilen bir işlev grubunu siler:

  firebase functions:delete GROUP_NAME

• Onay istemini atlar:

  firebase functions:delete FUNCTION-1_NAME --force

Dağıtım öncesi ve sonrası komut dosyası görevleri oluşturma

Dağıtım öncesi veya sonrası görevleri gerçekleştirmek için kabuk komut dosyalarını firebase deploy komutuna bağlayabilirsiniz. Örneğin, dağıtım öncesi komut dosyası TypeScript kodunu JavaScript'e derleyebilir ve dağıtım sonrası kanca, yöneticileri Firebase Hosting'ye dağıtılan yeni site içeriği hakkında bilgilendirebilir.

Dağıtım öncesi veya sonrası kancaları ayarlamak için firebase.json yapılandırma dosyanıza bash komut dosyaları ekleyin. Kısa komut dosyalarını doğrudan firebase.json dosyasında tanımlayabilir veya proje dizininizdeki diğer dosyalara referans verebilirsiniz.

Örneğin, aşağıdaki komut dosyası, Firebase Hosting adresine başarılı bir dağıtım yapıldıktan sonra Slack mesajı gönderen bir dağıtım sonrası görevi için firebase.json ifadesidir.

"hosting": {
  // ...

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

messageSlack.sh komut dosyası, proje dizininde bulunur ve şu şekilde görünür:

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

Dağıtabileceğiniz öğelerin herhangi biri için predeploy ve postdeploy kancaları ayarlayabilirsiniz. firebase deploy çalıştırmanın, firebase.json dosyanızda tanımlanan tüm dağıtım öncesi ve sonrası görevleri tetiklediğini unutmayın. Yalnızca belirli bir Firebase hizmetiyle ilişkili görevleri çalıştırmak için kısmi dağıtım komutlarını kullanın.

Hem predeploy hem de postdeploy kancaları, komut dosyalarının standart çıkışını ve hata akışlarını terminale yazdırır. Başarısız olan örnekler için aşağıdakileri göz önünde bulundurun:

• Bir dağıtım öncesi kanca beklendiği gibi tamamlanamazsa dağıtım iptal edilir.
• Dağıtım herhangi bir nedenle başarısız olursa dağıtım sonrası kancaları tetiklenmez.

Ortam değişkenleri

Dağıtım öncesi ve sonrası kancalarında çalışan komut dosyalarında aşağıdaki ortam değişkenleri kullanılabilir:

• $GCLOUD_PROJECT: Etkin projenin proje kimliği
• $PROJECT_DIR: firebase.json dosyasını içeren kök dizin
• $RESOURCE_DIR: (Yalnızca hosting ve functions komut dosyaları için) Dağıtılacak Hosting veya Cloud Functions kaynaklarını içeren dizinin konumu

Birden çok Realtime Database örneğini yönetme

Firebase projelerinde birden fazla Firebase Realtime Database örneği olabilir. CLI komutları varsayılan olarak varsayılan veritabanı örneğinizle etkileşim kurar.

Ancak --instance DATABASE_NAME işaretini kullanarak varsayılan olmayan bir veritabanı örneğiyle etkileşim kurabilirsiniz. Aşağıdaki komutlar --instance işaretini destekler:

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

Komut referansı

CLI yönetim komutları

Proje yönetimi komutları

Dağıtım ve yerel geliştirme

Bu komutlar, Firebase Hosting sitenizi dağıtmanıza ve sitenizle etkileşimde bulunmanıza olanak tanır.

App Distribution komutları

App Hosting komutları

Authentication (kullanıcı yönetimi) komutları

Cloud Firestore komutları

Cloud Functions for Firebase komutları

Daha fazla bilgi için ortam yapılandırma belgelerine bakın.

Crashlytics komutları

Data Connect komutları

Bu komutlar ve kullanım alanları Data Connect CLI referans kılavuzunda daha ayrıntılı olarak ele alınmıştır.

Extensions komutları

Extensions yayıncı komutları

Hosting komutları

Realtime Database komutları

İlk, varsayılan Realtime Database örneğinizi Firebase konsolunda veya genel firebase init iş akışını ya da belirli firebase init database akışını kullanarak oluşturabileceğinizi unutmayın.

Oluşturulan örnekleri, Birden fazla Realtime Database örneğini yönetme bölümünde açıklandığı şekilde yönetebilirsiniz.

Remote Config komutları