Firebase CLI リファレンス

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

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

CLI を設定または更新する

Firebase CLI をインストールする

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

Windows MacOS Linux

Windows

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

オプション 説明 推奨ユーザー
スタンドアロン バイナリ CLI のスタンドアロン バイナリをダウンロードします。実行可能ファイルに使用して、firebase コマンドを実行するシェルを開きます。 新規デベロッパー
Node.js を使用していない、または使い慣れていないデベロッパー
npm npm(Node Package Manager)を使用して CLI をインストールし、グローバルに使用可能な firebase コマンドを有効にします。 Node.js を使用するデベロッパー

スタンドアロン バイナリ

Firebase CLI のバイナリをダウンロードして実行する方法は次のとおりです。

  1. Windows 用の Firebase CLI バイナリをダウンロードします。

  2. バイナリにアクセスして、firebase コマンドを実行できるシェルを開きます。

  3. 続けてログインして CLI をテストします。

npm

npm(Node Package Manager)で Firebase CLI をインストールする手順は次のとおりです。

  1. nvm-windows(Node Version Manager)を使用して Node.js をインストールします。Node.js をインストールすると、npm コマンドツールが自動的にインストールされます。

  2. npm から Firebase CLI をインストールするには、次のコマンドを実行します。

    npm install -g firebase-tools

    これにより、グローバルに使用できる firebase コマンドが有効になります。

  3. 続けてログインして CLI をテストします。

Mac OS または Linux

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

オプション 説明 推奨ユーザー
自動インストール スクリプト オペレーティング システムの自動検出、最新の CLI リリースのダウンロード、グローバルに使用可能な firebase コマンドの有効化を行う、単一のコマンドを実行します。 新規デベロッパー
Node.js を使用していない、または使い慣れていないデベロッパー CI / CD 環境での自動デプロイ
スタンドアロン バイナリ CLI のスタンドアロン バイナリをダウンロードします。ダウンロードしたら、ワークフローに合わせてバイナリを構成し、実行できます。 CLI を使用して完全にカスタマイズできるワークフロー
npm npm(Node Package Manager)を使用して CLI をインストールし、グローバルに使用可能な firebase コマンドを有効にします。 Node.js を使用するデベロッパー

自動インストール スクリプト

自動インストール スクリプトで Firebase CLI をインストールする手順は次のとおりです。

  1. 次の cURL コマンドを実行します。

    curl -sL firebase.tools | bash

    このスクリプトは、ご使用のオペレーティング システムを自動的に検出し、最新の Firebase CLI リリースをダウンロードしてから、グローバルに使用可能な firebase コマンドを有効にします。

  2. 続けてログインして CLI をテストします。

自動インストール スクリプトのその他の例や詳細については、firebase.tools にあるスクリプトのソースコードをご覧ください。

スタンドアロン バイナリ

OS 固有の Firebase CLI のバイナリをダウンロードして実行する手順は次のとおりです。

  1. 次の OS の Firebase CLI バイナリをダウンロードします。Mac OS | Linux

  2. (省略可)グローバルに使用可能な firebase コマンドを設定します。

    1. chmod +x ./firebase_tools を実行して、バイナリを実行可能にします。
    2. バイナリのパスを PATH に追加します
  3. 続けてログインして CLI をテストします。

npm

npm(Node Package Manager)で Firebase CLI をインストールする手順は次のとおりです。

  1. nvm(Node Version Manager)を使用して Node.js をインストールします。
    Node.js をインストールすると、npm コマンドツールが自動的にインストールされます。

  2. npm から Firebase CLI をインストールするには、次のコマンドを実行します。

    npm install -g firebase-tools

    これにより、グローバルに使用できる firebase コマンドが有効になります。

  3. 続けてログインして CLI をテストします。

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

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

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

    firebase login

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

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

    firebase list

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

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

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

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

Windows

Mac OS

  • 自動インストール スクリプト: curl -sL firebase.tools | bash を実行します。
  • スタンドアロン バイナリ: 新しいバージョンをダウンロードして、システム上のバージョンを置き換えます。
  • npm: npm install -g firebase-tools を実行します。

Linux

  • 自動インストール スクリプト: curl -sL firebase.tools | bash を実行します。
  • スタンドアロン バイナリ: 新しいバージョンをダウンロードして、システム上のバージョンを置き換えます。
  • npm: npm install -g firebase-tools を実行します。

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

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

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

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

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

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

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

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

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

    • CI システム内で、すべての firebase コマンドに --token <token> フラグを指定して実行します。
      トークンを読み込む場合の優先順位は、フラグ、環境変数、必要な 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 ファイルでデプロイ前フックまたはデプロイ後フックを設定することもできます。

以下は、初期化時に 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"
    ]
  }
}

プロジェクト エイリアスを管理する

複数の Firebase プロジェクトを同じプロジェクト ディレクトリに関連付けることができます。たとえば、ステージング用と本番環境用に Firebase プロジェクトをそれぞれ 1 つ使用するとします。その場合、別のプロジェクト環境を使用することで、本番環境にデプロイする前に変更内容を確認できます。firebase use コマンドを使用すると、エイリアス間の切り替えや新しいエイリアスの作成を行うことができます。

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

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

firebase use --add

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

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

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

コマンド 説明
firebase use プロジェクト ディレクトリに現在定義されているエイリアスのリストを表示します。
firebase use \
project_id_or_alias
指定した Firebase プロジェクトにすべてのコマンドを実行します。
CLI は、このプロジェクトを現在のアクティブ プロジェクトとして使用します。
firebase use --clear default エイリアスが割り当てられた Firebase プロジェクトにすべてのコマンドを実行します。
CLI は、このプロジェクトを現在のアクティブ プロジェクトとして使用します。

このコマンドを実行すると、firebase use default を実行した場合と同じ結果になります。

firebase use \
--unalias project_alias
プロジェクト ディレクトリからエイリアスを削除します。

現在のアクティブ プロジェクトを変更するには、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 servelocalhost からのリクエストにのみ応答します。つまり、ホストされているコンテンツには同じパソコンのウェブブラウザからアクセスできますが、ネットワーク上の他のデバイスからはアクセスできません。他のローカル デバイスからテストする場合は、次のように --host フラグを使用します。

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

Firebase プロジェクトにデプロイする

Firebase CLI では、次のようなコードとアセットの Firebase プロジェクトへのデプロイを管理できます。

  • Firebase Hosting サイトの新規リリース
  • 新規、更新済み、既存の Cloud Functions for Firebase
  • 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 サービスの割り当て量の増加をリクエストします。たとえば、1 ユーザーの 100 秒あたりの書き込みリクエスト数という割り当てを適用することで、上記の Cloud Functions 429 エラーの解決につながる場合があります。

デプロイをロールバックする

プロジェクトの 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 構成ファイル内のキーに対応しています。

フラグの構文 デプロイされるサービスまたは機能
--only hosting Firebase Hosting のコンテンツ
--only database Firebase Realtime Database のルール
--only storage Cloud Storage for Firebase のルール
--only firestore Cloud Firestore のルールおよびインデックス
--only firestore:rules Cloud Firestore のルール
--only firestore:indexes Cloud Firestore のインデックス
--only functions Cloud Functions for Firebase(このフラグはより詳細な指定も可能です)

特定の関数をデプロイする

関数をデプロイするときは、特定の関数をターゲットにできます。次に例を示します。

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

もう一つのオプションは、/functions/index.js ファイルで関数をエクスポート グループにグループ化することです。関数をグループ化すると、1 つのコマンドで複数の関数をデプロイできます。

たとえば、次の関数を記述して groupAgroupB を定義できます。

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

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');

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 function1-name

  • デフォルト以外のリージョンで実行されている指定した関数を削除します。

    firebase functions:delete function1-name --region region-name

  • 複数の関数を削除します。

    firebase functions:delete function1-name function2-name

  • 指定した関数グループを削除します。

    firebase functions:delete group-name

  • 確認メッセージを省略します。

    firebase functions:delete function1-name --force

デプロイ前とデプロイ後にスクリプトで実行されるタスクを設定する

シェル スクリプトを firebase deploy コマンドに接続して、デプロイ前のタスクまたはデプロイ後のタスクを実施できます。たとえば、デプロイ前スクリプトで TypeScript コードを JavaScript にトランスパイルできます。また、デプロイ後フックで管理者に 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: hostingfunctions のスクリプトのみ)デプロイする Hosting または Cloud Functions のリソースが格納されているディレクトリの場所

複数の Realtime Database インスタンスを管理する

単一のプロジェクトに複数の Firebase Realtime Database インスタンスがあり、デフォルト以外のデータベース インスタンス(instance-name.firebaseio.com)を操作する場合は --instance instance-name オプションを使用します。

--instance オプションは次のコマンドでサポートされています。

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

コマンド リファレンス

CLI 管理コマンド

コマンド 説明
help CLI または特定のコマンドに関するヘルプ情報を表示します。
init 現在のディレクトリに新しい Firebase プロジェクトを関連付けて設定します。このコマンドを実行すると、firebase.json 構成ファイルが現在のディレクトリに作成されます。
list 非推奨。代わりに projects:list を使用してください。
アクセス権のある Firebase プロジェクトの一覧を表示します。
login Firebase アカウントを使用して CLI の認証を行います。ウェブブラウザにアクセスできる必要があります。
login:ci 非対話形式の環境で使用する認証トークンを生成します。
logout Firebase アカウントを CLI からログアウトします。
open 関連するプロジェクト リソースをブラウザで開きます。
projects:list アクセス権のある Firebase プロジェクトの一覧を表示します。
use CLI にアクティブな Firebase プロジェクトを設定します。
プロジェクトのエイリアスを管理します。

プロジェクト管理コマンド

コマンド 説明
apps:create アクティブ プロジェクトに新しい Firebase アプリを作成します。
apps:list アクティブ プロジェクトに登録済みの Firebase アプリを一覧表示します。
apps:sdkconfig Firebase アプリの Google サービスの構成を出力します。
projects:addfirebase Firebase リソースを既存の Google Cloud Platform(GCP)プロジェクトに追加します。
projects:create 新しい Google Cloud Platform(GCP)プロジェクトを作成し、新しいプロジェクトに Firebase リソースを追加します。
projects:list アクセス権のある Firebase プロジェクトの一覧を表示します。
setup:web 非推奨。代わりに apps:sdkconfig を使用し、プラットフォーム引数として web を指定してください。
Firebase ウェブアプリの Google サービスの構成を出力します。

デプロイとローカルでの開発

次のコマンドを使用すると、デプロイおよび Firebase Hosting サイトとの通信を行うことができます。

コマンド 説明
deploy プロジェクト ディレクトリからアクティブ プロジェクトにコードとアセットをデプロイします。Firebase Hosting の場合、firebase.json 構成ファイルが必要です。
serve Firebase Hosting の構成を使用してローカル ウェブサーバーを起動します。Firebase Hosting の場合、firebase.json 構成ファイルが必要です。

App Distribution コマンド

コマンド 説明
appdistribution:distribute \
--app firebase-app-id
テスターがビルドを利用できるようにします。

Authentication(ユーザー管理)コマンド

コマンド 説明
auth:export アクティブ プロジェクトのユーザー アカウントを JSON または CSV ファイルにエクスポートします。詳細については、auth:import and auth:export のページをご覧ください。
auth:import JSON または CSV ファイルからアクティブなプロジェクトにユーザー アカウントをインポートします。詳細については、auth:import and auth:export のページをご覧ください。

Cloud Firestore コマンド

コマンド 説明
firestore:delete アクティブ プロジェクトのデータベース内のドキュメントを削除します。CLI を使用すると、コレクション内のすべてのドキュメントを再帰的に削除できます。

Cloud Functions for Firebase コマンド

コマンド 説明
functions:config:clone 別のプロジェクトの環境のクローンをアクティブな Firebase プロジェクトに作成します。
functions:config:get アクティブ プロジェクトの Cloud Functions の既存の構成値を取得します。
functions:config:set アクティブ プロジェクトの Cloud Functions のランタイム構成値を保存します。
functions:config:unset アクティブ プロジェクトのランタイム構成から値を削除します。
functions:log デプロイされた Cloud Functions からログを読み取ります。

詳細については、環境構成のドキュメントをご覧ください。

拡張機能コマンド

コマンド 説明
ext Firebase 拡張機能コマンドの使用方法を表示します。
アクティブ プロジェクトにインストールされている拡張機能を一覧表示します。
ext:configure \
extension-instance-id
ワークフローを開始し、インストールされている拡張機能のパラメータ値を再構成します。
ext:info \
extension-name
公式の Firebase 拡張機能の詳細情報を出力します。
ext:install \
extension-name
ワークフローを開始し、公式の Firebase 拡張機能を Firebase プロジェクトにインストールします。
ext:list Firebase プロジェクトにインストールされている拡張機能の一覧を表示します。
各拡張機能のインスタンス ID を出力します。
ext:uninstall \
extension-instance-id
Firebase プロジェクトから拡張機能をアンインストールします。
ext:update \
extension-instance-id
ワークフローを開始して、インストールされている拡張機能を新しいバージョンに更新します。

ホスティング コマンド

コマンド 説明
hosting:disable アクティブな Firebase プロジェクトの Firebase Hosting トラフィックの処理を停止します。このコマンドを実行した後、プロジェクトの Hosting URL に「サイトが見つかりません」というメッセージが表示されます。

Realtime Database のコマンド

コマンド 説明
database:get アクティブ プロジェクトのデータベースからデータを取得し、JSON として表示します。インデックス付きデータのクエリがサポートされます。
database:profile アクティブ プロジェクトのデータベースにオペレーションのプロファイルを作成します。詳細については、Realtime Database オペレーション タイプをご覧ください。
database:push アクティブ プロジェクトのデータベースの指定場所にあるリストに新しいデータを追加します。ファイル、STDIN またはコマンドライン引数から入力を取得します。
database:remove アクティブ プロジェクトのデータベースの指定場所にあるデータをすべて削除します。
database:set アクティブ プロジェクトのデータベース内の指定場所にあるデータをすべて置き換えます。ファイル、STDIN またはコマンドライン引数から入力を取得します。
database:update アクティブ プロジェクトのデータベース内の指定場所で部分更新を実行します。ファイル、STDIN またはコマンドライン引数から入力を取得します。