Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/francostramana/firetools
Command Line Interface (CLI) for Firebase Admin Management :fire:
https://github.com/francostramana/firetools
Last synced: 2 months ago
JSON representation
Command Line Interface (CLI) for Firebase Admin Management :fire:
- Host: GitHub
- URL: https://github.com/francostramana/firetools
- Owner: francostramana
- Created: 2020-01-01T23:14:10.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-09T21:03:14.000Z (almost 2 years ago)
- Last Synced: 2024-09-28T17:01:41.483Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 1.66 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Firetool CLI
Firetool is a Command Line Interface (CLI) that allows you to do everything you can't do with Firebase Web Console. Ok, not everything... But a lot of those ;)
## Installation
### Node Package
You can easily download and install the Firetool CLI using npm (the Node Package Manager).
```bash
npm install -g firetool
```
This will provide you with the globally accessible `firetool` command.
Note that you will need to install
[Node.js](http://nodejs.org/) and [npm](https://npmjs.org/). Installing Node.js should install npm as well.
## Initialize
To authenticate a service account and authorize it to access Firebase services, you must provide a *private key*1 through:
```bash
firetool init
```
this will prompt you for the Firebase Database Name and your Private Key.
**1To generate a private key file for your service account:**
1. In the Firebase console, open **Settings > Service Accounts**.
2. Click **Generate New Private Key**, then confirm by clicking Generate Key.
3. **Securely store** the JSON file containing the key.
See https://firebase.google.com/docs/admin/setup#initialize-sdk
## Commands
**You can list the avalaible commands running `firetool --help` or `firetool --help ` for more details.**
| **Command** | **Description** |
|-------------|------------------------------------------------|
| init | Init Firebase Tools. |
| user | Tools for Firebase Authentication admin tools. |
| help | Display help for [cmd] |
### User/Authenticacion commands
This commands allow you to managing your Firebase Authentication users with elevated privileges.
| **Command** | **Description** |
|-------------------------------|------------------------------------------------------------------------------------|
| user list [uid] | Retrieves a list of user(s). |
| user create [options] | Create a new Firebase Authentication user. |
| user update [options] \ | Updates an existing user by their uid. |
| user delete \ | Delete a existing user by their uid. |
| user validate-email \ | Validates email to existing user. Shorthand to user update \ --emailVerified.|
| user claims \ [options] | Configure custom claims to existing user. |
`[options]` params are the same properties provides by the API for managing Firebase Authentication. See https://firebase.google.com/docs/auth/admin/manage-users.
For example:
- `firetool user update --emailVerified jcIT3i4hFNSqmgxABFxH1sVxc1M2` validate user email.
- `firetool user update --displayName "Franco Stramana" jcIT3i4hFNSqmgxABFxH1sVxc1M2` change the display name for the user.
- `firetool user update --password 123456 --disabled false jcIT3i4hFNSqmgxABFxH1sVxc1M2` enabled user and change their password.
**Claims**
- `firetool user claims jcIT3i4hFNSqmgxABFxH1sVxc1M2 --set admin=true` set admin token custom claims.
- `firetool user claims jcIT3i4hFNSqmgxABFxH1sVxc1M2 --removeAll` remove all custom claims.
## Contributions
This project was born as a personal tool that I decided to share. It will grow as I need more features for my personal projects. Because of this, any contribution is welcome ;)
**Made with Node and Love!** (and of course, a few dependencies)