Firebase CLI referansı

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

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

KSA'yı ayarlama veya güncelleme

Firebase CLI'ı yükleyin

Firebase KSA'yı, işletim sisteminize uygun bir yöntem kullanarak yükleyebilirsiniz deneyim düzeyi ve/veya kullanım alanı gibi sorular sorarsınız. 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'yı yükledikten sonra kimlik doğrulaması yapmanız gerekir. Ardından, Firebase projelerinizi listeleyerek kimlik doğrulaması yapabilirsiniz.

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

   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örüntülenen liste, şurada listelenen Firebase projeleriyle aynı olmalıdır: Firebase konsolunda bulabilirsiniz.

KSA'yı en son sürümüne güncelleyin

Genellikle en güncel Firebase KSA 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 depolayı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ı: işaret, ortam değişkeni, istenen Firebase projesi.

Firebase projesini başlatma

CLI kullanılarak gerçekleştirilen yaygın görevlerden bazıları (ör. Firebase projesine dağıtma) için proje dizini gerekir. firebase init komutunu kullanarak bir proje dizini oluşturursunuz. Proje dizini genellikle aynı olur dizinini kaynak kontrol kök olarak ayarlayın ve firebase init çalıştırıldıktan sonra, dizin bir firebase.json yapılandırması içeriyor dosyası olarak kaydedebilirsiniz.

Yeni bir Firebase projesini başlatmak için uygulamanın dizini:

firebase init

firebase init komutu, proje dizininizi oluşturma adımlarında size yol gösterir ve bazı Firebase ürünlerinde kullanılır. 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ım, geçerli proje dizinini bir Firebase projesiyle ilişkilendirir. komut dosyasına göre çalışan, projeye özgü komutların (firebase deploy gibi) doğru Firebase projesini kullanın.

  Ayrıca bir sürü birden çok Firebase projesi ilişkilendirme (ör. hazırlık projesi ve üretim projesi) aynı projenin dizin.

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

• Aşağıdakileri içeren bir firebase.json yapılandırma dosyası en iyi uygulamaları gözden geçirmelisiniz.

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

firebase.json dosyası

firebase init komutu, firebase.json yapılandırma dosyası oluşturun.

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 ya projenizde tanımlanabileceğinden dizini veya Firebase konsolu kullanıyorsanız olası sorunları dağıtım çakışmaları.

Firebase Hosting seçeneklerinin çoğunu yapılandırabilirsiniz. doğrudan firebase.json dosyasına gönderebilirsiniz. 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"
    ]
  }
}

firebase.json varsayılan olarak kullanılsa da Alternatif bir yöntem belirtmek için --config PATH işareti yapılandırma dosyası.

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

firebase init komutunu çalıştırdığınızda firebase.json dosyanız tek bir Aşağıda gösterildiği gibi, projenizin varsayılan veritabanına karşılık gelen firestore anahtarı bölümünü ziyaret edin.

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ı şununla değiştirin: Her veritabanı için bir giriş içeren JSON dizisi.

      "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 dosya

İşlev dağıtım anında CLI, işlev dağıtımı sırasında functions dizininde yoksayılacak dosyaların listesi. Bu gereksiz dosyalara dağıtım yapmayı önler. dağıtımınızın veri boyutunu artırır.

Varsayılan olarak yok sayılan dosyaların JSON biçiminde gösterilen listesi:

"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 sırasında bir Firebase projesi seçtiğinizde başlatma durumunda, proje otomatik olarak default e-posta adresine sahip kullanıcının takma adı atandı. Ancak projeye özel komutların çalışırken aynı projeyi kullanmaya devam edebilir aşağıdaki komutu proje dizininizden çalıştırın:

firebase use --add

Bu komut, başka bir Firebase projesi seçmenizi ve takma ad olarak ekleyebilirsiniz. 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.

--project işaretini herhangi bir CLI komutuyla 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 projeleri 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 sunma 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 komutu yerel proje dizininizin kök dizininden çalıştırın: aşağıdakilerden birini yapmanız gerekir:

• Firebase tarafından barındırılan uygulamanızın statik içeriğini görüntüleyin.
• Şunun için dinamik içerik oluşturmak üzere: Cloud Functions Firebase Hosting kullanıyorsanız ve Yerel URL'de Hosting emülasyonunu kullanmak için production (dağıtıldı) HTTP işlevleri.

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.

• Yerel URL'lerde test etmek üzere HTTP işlevlerine ve barındırmaya öykünmek için aşağıdaki komutlardan birini seçin:

  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 kaynağından 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, Firebase projenize kod ve öğe dağıtımını yönetir. Örneğin:

• Firebase Hosting sitenizin 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 dizinleri

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 yorumla projenizin diğer dağıtım bilgileriyle birlikte Firebase Hosting sayfasını ziyaret edin. Ö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 dizini firebase.json dosyası olmalıdır. Bu dosya tarafından sizin için otomatik olarak oluşturulan firebase init komutunun bir örneğini burada bulabilirsiniz.

• 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ı için dağıtım çakışmaları

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

Dağıtım çakışmalarını önlemenin diğer bir yolu da kısmi dağıtım kullanın ve Firebase konsolu.

Dağıtım kotaları

Bazı durumlarda, genellikle çok kısa bir süre içinde Firebase dağıtım işlemlerinizin hızı veya hacmi. Örneğin, çok sayıda işlev dağıtıyorsanız HTTP 429 Quota mesajının gösterilmesini sağlar. Bu tür sorunları çözmek için kısmi dağıtımdan yararlanın.

Dağıtımı geri çekme

Bir Firebase Hosting dağıtımını projenizin şuradan geri alabilirsiniz: Firebase Hosting sayfasını ziyaret ederek İstenen sürüm için Geri Al işlemi.

Ş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çeriğini dağıtır ve Cloud Storage güvenlik kuralı.

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, işlevlerinizi /functions/index.js dosyası oluşturun. İşlevleri gruplandırmak birden fazla işlevlerini tek bir komutla kontrol edebilirsiniz.

Örneğin, bir groupA ve bir groupB:

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

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

Bu örnekte, ayrı bir functions/groupB.js dosyası ek groupB içindeki işlevleri tanımlayan işlevleri içerir. Ö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, şu komutu çalıştırarak tüm groupA işlevlerini dağıtabilirsiniz: proje dizininizden şu komutu ekleyin:

firebase deploy --only functions:groupA

Alternatif olarak, aşağıdaki komutu çalıştırarak grup içindeki belirli bir işlevi hedefleyebilirsiniz. komut:

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.

Predeploy veya postdeploy kancaları ayarlamak için firebase.json yapılandırma dosyası. 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

Şunların herhangi biri için predeploy ve postdeploy kancaları ayarlayabilirsiniz: Dağıtabileceğiniz öğeler. 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ı standart çıkışı ve hatayı yazdırır komut dosyası akışlarının terminale aktarılmasını sağlar. Hata durumlarında 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 postdeploy 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önetin

Firebase projelerinde birden fazla Firebase Realtime Database örneği olabilir. Ölçüt CLI komutları default olarak veritabanı örneğinizle etkileşime girer.

Ancak şunu kullanarak varsayılan olmayan bir veritabanı örneğiyle etkileşim kurabilirsiniz: --instance DATABASE_NAME işareti. İlgili içeriği oluşturmak için kullanılan 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şim kurmanı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 ortama bakın yapılandırma dokümanlarını inceleyin.

Crashlytics komutları

Data Connect komutları

Bu komutlar ve kullanım alanları şurada daha ayrıntılı olarak ele alınmıştır: Data Connect KSA referans kılavuzu.

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 şurada açıklandığı gibi yönetebilirsiniz: Birden çok Realtime Database örneğini yönetin.

Remote Config komutları