blazeman - Cloud Firestore CLI

blazeman is a command line interface for Cloud Firestore written in Rescript. blazeman that makes query and update easy.

Installation

To install run

$ npm install -g blazeman

How to Use

Prerequisites

Set the environment variable GOOGLE_APPLICATION_CREDENTIALS to the file path of the json file containing the service account key.

Commands overview

bm, show current project name.

1$ bm
2Active Project: XXXXXXXX

bm list, which lists collections.

1$ bm list
2[
3  "collection1",
4  "collection2",
5]

bm docs, retrieve docs in the collection.

1$ bm docs "/collection1/[enabled == true]/{id, name, description, enabled}"
2[
3  {
4      id: "test",
5      name: "name",
6      description: "description",
7      enabled: true
8  }
9]

bm set, to add or set an document.

1$ bm set "/collection1/docId1" --json='{"field1": 1, "field2": "2"}' --dry-run=false
2{
3  "field1": 1
4  "field2": "2"
5}
6$ echo '{"field1": 1, "field2": "2"}' | bm set "/collection1/docId1" --dry-run=false
7{
8  "field1": 1
9  "field2": "2"
10}

bm update, to update an document.

1$ bm update "/collection1/docId1" --json='{"field1": 10}' --dry-run=false
2{
3  "field1": 10
4  "field2": "2"
5}
6$ echo '{"field1": 10}' | bm update "/collection1/docId1" --dry-run=false
7{
8  "field1": 10
9  "field2": "2"
10}

To find more features, bm help or bm [Subcommands] help will show you complete list of available commands.

1$ bm help
2bm is a command line tool to Firebase firestore.
3Usage:
4    bm  Show current project id
5    bm <Subcommands> [Options]
6
7Subcommands:
8    get    Retrieve an doc by specifying collection path.
9    docs   Retrieve docs in a collection.
10    set    Create a new doc, or replace an existing doc.
11    update Update an existing doc.
12    delete Delete an existing collection or doc.
13    help   Prints this message
14$ bm docs help
15Get documents from Firestore collection.
16
17Usage:
18    bm docs "[Collectiotn path]" [Options]
19    bm docs "[Collectiotn path]/[Queries]" [Options]
20    bm docs "[Collectiotn path]/[Queries]/[Fields|Order by]" [Options]
21    bm docs code "[Collectiotn path]/[Queries]/[Fields|Order by]" [Options]
22
23Collectiotn path:
24    /collection
25    /collection/docid/subcollection
26Queries:
27    /[field == 'string value']
28    /[field == int value]/
29    /[field == true]/
30    /[field == false]/
31    /[field != value]/
32    /[field >= value]/
33    /[field > value]/
34    /[field < value]/
35    /[field <= value]/
36    /[map.value == value]/
37    /[array contains value]/
38Fields:
39    /{field1, field2}
40Order by:
41    /{^field1, _field2}
42Options:
43    -l, --limit=<limit> defaults to 30
44    -s, --offset=<offset> defaults to 0
45    -a, --start-at=<startAt>
46    -f, --format=<json|table|csv>

License

MIT