Firebase CLI リファレンス

Firebase CLI（GitHub）は、Firebase プロジェクトの管理、表示、デプロイを行うさまざまなツールを提供します。

Firebase CLI を使用する前に、Firebase プロジェクトを設定してください。

CLI を設定または更新する

Firebase CLI をインストールする

ご使用のオペレーティング システム、経験レベル、ユースケースに合わせて、Firebase CLI をインストールする方法を選ぶことができます。CLI のインストール方法に関係なく、利用できる機能と firebase コマンドは同じです。

Windows macOS Linux

Windows

Windows 用の Firebase CLI をインストールするには、次のいずれかのオプションを選びます。

macOS または Linux

macOS または Linux 用の Firebase CLI をインストールするには、次のいずれかのオプションを選びます。

Firebase CLI にログインしてテストする

CLI をインストールしたら、認証する必要があります。その後で Firebase プロジェクトを一覧表示して認証を確認できます。

1. Google アカウントで Firebase にログインするには、次のコマンドを実行します。

   firebase login

   このコマンドにより、ローカルマシンが Firebase に接続され、Firebase プロジェクトへのアクセスが許可されます。

2. Firebase プロジェクトを一覧表示し、CLI が正しくインストールされていて、アカウントにアクセスしていることをテストします。次のコマンドを実行します。

   firebase projects:list

   Firebase コンソールと同じ Firebase プロジェクトが表示されているはずです。

最新の CLI バージョンに更新する

一般には、Firebase CLI の最新バージョンを使用することをおすすめします。

CLI バージョンの更新方法は、使用しているオペレーティング システムと CLI のインストール方法によって異なります。

CI システムで CLI を使用する

Firebase CLI で認証を完了するにはブラウザが必要ですが、CLI は CI およびその他のヘッドレス環境と完全に互換性があります。

1. ブラウザがインストールされたマシンに、Firebase CLI をインストールします。

2. 次のコマンドを実行して、ログイン プロセスを開始します。

   firebase login:ci

3. 指定された URL にアクセスし、Google アカウントを使用してログインします。

4. 新しい更新トークンを出力します。現在の CLI セッションは影響を受けません。

5. 安全かつアクセス可能な方法で、CI システムに出力トークンを保存します。

6. このトークンは、firebase コマンドを実行するときに使用します。次のいずれかのオプションを使用できます。

   • オプション 1: トークンを環境変数 FIREBASE_TOKEN として保存する。システムはこのトークンを自動的に使用します。

   • オプション 2: CI システムで --token TOKEN フラグを指定してすべての firebase コマンドを実行する。
     トークンを読み込む際の優先順位は、フラグ、環境変数、必要な 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 deploy など）が適切な Firebase プロジェクトに対して実行されるように、現在のプロジェクト ディレクトリが Firebase プロジェクトに関連付けられます。

  また、同じプロジェクト ディレクトリに複数の Firebase プロジェクトを関連付けることもできます（ステージング プロジェクトと本番環境プロジェクトなど）。

初期化の最後に、Firebase は次の 2 つのファイルを自動的に作成し、ローカルアプリ ディレクトリのルートに追加します。

• プロジェクトの構成を含む firebase.json 構成ファイル。

• プロジェクト エイリアスが保存される .firebaserc ファイル。

firebase.json ファイル

firebase init コマンドによって、プロジェクト ディレクトリのルートに firebase.json 構成ファイルが作成されます。

firebase.json ファイルは、Firebase CLI でアセットをデプロイするために必要です。このファイルにより、どのファイルと設定がプロジェクト ディレクトリから Firebase プロジェクトにデプロイされるかが指定されます。一部の設定はプロジェクト ディレクトリまたは Firebase コンソールで定義できるため、発生しうるデプロイの競合を解決してください。

ほとんどの Firebase Hosting オプションの構成は、firebase.json ファイル内で直接行うことができます。ただし、その他の Firebase CLI でデプロイできる Firebase サービスについては、firebase init コマンドによって特定のファイルが作成され、そのファイルでそれらのサービスの設定を定義できます（Cloud Functions 用の index.js ファイルなど）。firebase.json ファイルでデプロイ前フックまたはデプロイ後フックを設定することもできます。

初期化時に TypeScript のソースと lint オプションを選択した状態で Firebase Hosting、Cloud Firestore、Cloud Functions for Firebase を選択した場合、デフォルトの設定を含む 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ファイルには、上記のように、プロジェクトのデフォルトのデータベースに対応する 1 つの firestore キーが含まれます。

プロジェクトに複数の Cloud Firestore データベースが含まれている場合は、firebase.json ファイルを編集して、各データベースにそれぞれ異なる Cloud Firestore Security Rules とデータベース インデックス ソースファイルを関連付けます。データベースごとに 1 つのエントリを含む 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 プロジェクトをそれぞれ 1 つ使用するとします。その場合、別のプロジェクト環境を使用することで、本番環境にデプロイする前に変更内容を確認できます。firebase use コマンドを使用すると、エイリアス間の切り替えや新しいエイリアスの作成を行うことができます。

プロジェクト エイリアスを追加する

プロジェクトの初期化中に Firebase プロジェクトを選択すると、プロジェクトに default というエイリアスが自動的に割り当てられます。ただし、プロジェクト固有のコマンドを別の Firebase プロジェクトに対して実行しつつ、同じプロジェクト ディレクトリを使用するには、プロジェクト ディレクトリから次のコマンドを実行します。

firebase use --add

このコマンドを実行すると、別の Firebase プロジェクトを選択し、そのプロジェクトをエイリアスとして割り当てるように求められます。エイリアスの割り当ては、プロジェクト ディレクトリ内にある .firebaserc ファイルに書き込まれます。

プロジェクト エイリアスを使用する

割り当てられた Firebase プロジェクト エイリアスを使用するには、プロジェクト ディレクトリから次のいずれかのコマンドを実行します。

現在アクティブ プロジェクトを変更するには、CLI コマンドに --project フラグを渡します。例: staging エイリアスを割り当てた Firebase プロジェクトに実行するように CLI を設定できます。たとえば、prod エイリアスを割り当てた Firebase プロジェクトに単一のコマンドを実行する場合は、firebase deploy --project=prod を実行します。

ソース管理とプロジェクト エイリアス

一般に、チームでプロジェクト エイリアスを共有するには、.firebaserc ファイルをソース管理にチェックインします。ただし、オープンソース プロジェクトまたはスターター テンプレートについては、通常 .firebaserc ファイルをチェックインするべきではありません。

自分専用の開発プロジェクトがある場合は、各コマンドとともに --project フラグを渡すか、Firebase プロジェクトにエイリアスを割り当てずに firebase use PROJECT_ID を実行できます。

Firebase プロジェクトをローカルで実行してテストする

本番環境にデプロイする前に、ローカルでホストされる URL で Firebase プロジェクトを表示してテストできます。選択した機能のみをテストする場合は、firebase serve コマンドのフラグ内でカンマ区切りのリストを使用します。

次のいずれかのタスクを行う場合は、ローカル プロジェクト ディレクトリのルートから以下のコマンドを実行します。

• Firebase がホストするアプリの静的コンテンツを表示する。
• Cloud Functions を使用して Firebase Hosting の動的コンテンツを生成し、本番環境（デプロイ済み）の HTTP 関数を使用して、ローカル URL で Hosting をエミュレートする。

firebase serve --only hosting

ローカル HTTP 関数を使用してプロジェクトをエミュレートする

プロジェクト ディレクトリから次のいずれかのコマンドを実行し、ローカル HTTP 関数を使用してプロジェクトをエミュレートします。

• テストのためにローカル URL で HTTP 関数およびホスティングをエミュレートするには、次のいずれかのコマンドを使用します。

  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 ファイルで関数をエクスポート グループにグループ化することです。関数をグループ化すると、1 つのコマンドで複数の関数をデプロイできます。

たとえば、次の関数を記述して 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 コマンドに接続して、デプロイ前のタスクまたはデプロイ後のタスクを実施できます。たとえば、デプロイ前スクリプトで TypeScript コードを JavaScript にトランスパイルできます。また、デプロイ後フックで管理者に Firebase Firebase Hosting への新しいサイト コンテンツのデプロイを通知することも可能です。

デプロイ前フックまたはデプロイ後フックを設定するには、firebase.json 構成ファイルに bash スクリプトを追加します。firebase.json ファイルで簡単なスクリプトを直接定義するか、プロジェクト ディレクトリ内にある他のファイルを参照できます。

たとえば、次のスクリプトは、Firebase Hosting へのデプロイが成功した場合に Slack メッセージを送信するデプロイ後のタスクの firebase.json 式です。

"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: アクティブ プロジェクトの ID
• $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 コマンド