From b2c1391715be8f8dee2eeb2aac131bd27eae1e88 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=96mer=20Ayhan?= Date: Sat, 7 Mar 2026 19:24:39 +0300 Subject: [PATCH] docs: add index.html for cli homepage --- README.md | 22 +++-- docs/index.html | 242 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 254 insertions(+), 10 deletions(-) create mode 100644 docs/index.html diff --git a/README.md b/README.md index 34a5c69..99912c0 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,8 @@ The Firebase Tools CLI is a command-line interface for managing Firebase services including Firestore, Realtime Database, and Remote Config. It provides powerful tools to export, import, query, and manage your Firebase data from the command line. +📄 [Privacy Policy](docs/PRIVACY.md) • [Terms of Service](docs/TERMS.md) + - Export/Import data from Firestore and Realtime Database - Query collections and documents with advanced filtering - Convert JSON files to Firebase Remote Config format @@ -64,20 +66,20 @@ Below is a brief list of the available commands and their function: ### Firestore Commands -| Command | Description | -| -------------------- | ------------------------------------------------------------------------------------------------------------------- | -| **firestore:export** | Export all collections from Firestore to a single compact importable JSON file (`firestore_export.json`). Supports subcollection handling and collection exclusions. | -| **firestore:import** | Import data to Firestore from JSON file. Supports batch operations and merge functionality. | -| **firestore:list** | List all collections and their basic information from the current project's Firestore database. | +| Command | Description | +| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **firestore:export** | Export all collections from Firestore to a single compact importable JSON file (`firestore_export.json`). Supports subcollection handling and collection exclusions. | +| **firestore:import** | Import data to Firestore from JSON file. Supports batch operations and merge functionality. | +| **firestore:list** | List all collections and their basic information from the current project's Firestore database. | | **firestore:query** | Query a collection or fetch a specific document. Supports subcollection paths (e.g., `users user1 orders`), collection group queries (`--collection-group`), advanced filtering, ordering, and field-specific queries. | ### Realtime Database Commands -| Command | Description | -| --------------- | ----------------------------------------------------------------------------------------------------------- | -| **rtdb:export** | Export all data from Realtime Database to a single compact importable JSON file (`rtdb_export.json`). Supports exclusion options and top-level-only export. | -| **rtdb:import** | Import data to Realtime Database from JSON file. Supports batch operations and merge functionality. | -| **rtdb:list** | List all top-level nodes and their basic information from the current project's Realtime Database. | +| Command | Description | +| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **rtdb:export** | Export all data from Realtime Database to a single compact importable JSON file (`rtdb_export.json`). Supports exclusion options and top-level-only export. | +| **rtdb:import** | Import data to Realtime Database from JSON file. Supports batch operations and merge functionality. | +| **rtdb:list** | List all top-level nodes and their basic information from the current project's Realtime Database. | | **rtdb:query** | Query a specific path in Realtime Database. Supports deep nested paths (e.g., `/root/a/b/c`), nested field filters (`field/subfield,==,value`), ordering, and JSON output with file saving. | ### Remote Config Commands diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..2b6a879 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,242 @@ + + + + + + + Firebase Tools CLI + + + +
+

🔥 Firebase Tools CLI

+

+ Command-line interface for managing Firebase services +

+ +

+ A powerful CLI tool for managing Firebase Firestore, Realtime Database, + and Remote Config. Export, import, query, and manage your Firebase data + with ease from the command line. +

+ +
+
    +
  • Export/Import data from Firestore and Realtime Database
    • +
  • Query collections and documents with advanced filtering
    • +
  • Convert JSON files to Firebase Remote Config format
    • +
  • Manage authentication and project settings
    • +
  • Batch operations with customizable batch sizes
    • +
+
+ +
+ Installation:
+ $ npm install -g firebase-tools-cli +
+ +
+ + View on GitHub + + + View on NPM + +
+ +
+ Documentation + Privacy Policy + Terms of Service + Report Issue +
+ + +
+ +