Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

@firemanjs/fireman

0.0.8 • Public • Published

A cli and desktop client for Firebase databases that makes querying and managing easy.

Install

To install run

$ npm install -g @firemanjs/fireman

This package only contains Fireman API and CLI, for the Electron app refer to fireman-electron. (Not yet released)

Usage

Fireman uses a custom query language called FiremanQL. To learn more about it see FiremanQL Docs.

Once installed, this package exposes the fireman command.

CLI documentation

fireman project:add <serviceAccountKeyPath> <dbUrl>

Adds a Firebase project to your environment.

Parameter Description
serviceAccountKeyPath The absolute path of the service account key JSON file
dbUrl The .firebaseio.com url of your database

See add firebase to your app to know how to generate the service account file and to find the db url.

fireman project:use

Starts an interactive shell that lets you choose which project to use from now on.

fireman project:remove

Starts an interactive shell that lets you choose which project to remove (locally).

fireman firestore [query]

If no query is provided, starts the Fireman interactive shell, otherwise performs query.

fireman realtime [query]

If no query is provided, starts the Realtime interactive shell, otherwise performs query.

Query options

The following options can be appended to queries:

-l listens for changes in the queried data and updates the output in real time.

License

This project is licensed under the MIT License - see the LICENSE file for details

Install

npm i @firemanjs/fireman

DownloadsWeekly Downloads

6

Version

0.0.8

License

MIT

Unpacked Size

111 kB

Total Files

32

Last publish

Collaborators

  • avatar
  • avatar