Skip to content
This repository has been archived by the owner on May 16, 2021. It is now read-only.

Commit

Permalink
Update Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@mainawycliffe
mainawycliffe committed Apr 19, 2020
1 parent 8d12314 commit 95f68e1
Show file tree
Hide file tree
Showing 17 changed files with 45 additions and 20 deletions.
16 changes: 16 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,22 @@ as soon as possible.

> Kamanda is a fully open source project, no information is corrected at any time.
### CI Environment

If you are in CI environment, you can use the `--token` flag to pass the
firebase refresh token without login in. You can acquire the refresh token by
running `kamanda login:ci`.

### Multiple Project Support

Kamanda also support multiple Firebase project within the same workspace just
like `firebase cli`. You can use the `--project` flag to pass either the project
name or project alias you wish to execute the command on. If the flag is not
specified, Kamanda uses the `default` project with the workspace. This is
usually specified inside the `.firebaserc` file at the root of you workspace.
Please note, Kamanda cannot be used to setup multiple projects, this can only be
done using Firebase CLI.

## Features

- Firebase Auth Users:
Expand Down
9 changes: 7 additions & 2 deletions cmd/root.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,13 @@ const description = `Kamanda is a Firebase CLI Tool extender and should be used
Kamanda provides additional functionality currently not available to via the
Firebase CLI Tool such as User Management, Cloud Firestore Management etc from the CLI.
For instance, it allows you to easily create users with custom tokens,
which is always a trick preposition.`
For instance, it allows you to easily create users with custom tokens, which is always a trick preposition.
You can use the "--token" flag to specify the firebase refresh token to use for your project and the
"--project" to specify the project or project alias to executes the commands on.
The "--token" flag is ideal for a CI environment, where the firebase refresh token can be passed to the
environment securely. You can get your refresh token by running "kamanda login:ci" or "firebase login:ci".`

var cfgFile string

Expand Down
11 changes: 8 additions & 3 deletions docs/kamanda.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,13 @@ Kamanda is a Firebase CLI Tool extender and should be used alongside it.
Kamanda provides additional functionality currently not available to via the
Firebase CLI Tool such as User Management, Cloud Firestore Management etc from the CLI.

For instance, it allows you to easily create users with custom tokens,
which is always a trick preposition.
For instance, it allows you to easily create users with custom tokens, which is always a trick preposition.

You can use the "--token" flag to specify the firebase refresh token to use for your project and the
"--project" to specify the project or project alias to executes the commands on.

The "--token" flag is ideal for a CI environment, where the firebase refresh token can be passed to the
environment securely. You can get your refresh token by running "kamanda login:ci" or "firebase login:ci".

### Options

Expand All @@ -32,4 +37,4 @@ which is always a trick preposition.
* [kamanda logout](kamanda_logout.md) - Logout kamanda from Firebase
* [kamanda version](kamanda_version.md) - Version will output the current build information

###### Auto generated by spf13/cobra on 17-Apr-2020
###### Auto generated by spf13/cobra on 19-Apr-2020
2 changes: 1 addition & 1 deletion docs/kamanda_auth.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ Perform Firebase Auth Operations
* [kamanda auth find](kamanda_auth_find.md) - Find a a Firebase Auth user by their Firebase UID.
* [kamanda auth users](kamanda_auth_users.md) - Fetch and display a list of users in firebase auth.

###### Auto generated by spf13/cobra on 17-Apr-2020
###### Auto generated by spf13/cobra on 19-Apr-2020
3 changes: 1 addition & 2 deletions docs/kamanda_auth_addUser.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ Add a new Firebase Email/Password user (Accepts Custom Claims)
Creates a new Firebase User (Email/Password). Both the Email and the Password are required.

You can also add custom claims using --custom-claims="key:value" flag.


```
kamanda auth addUser [flags]
Expand Down Expand Up @@ -47,4 +46,4 @@ kamanda auth addUser --email [email protected] --password 1234 --custom-claims "

* [kamanda auth](kamanda_auth.md) - Perform Firebase Auth Operations

###### Auto generated by spf13/cobra on 17-Apr-2020
###### Auto generated by spf13/cobra on 19-Apr-2020
2 changes: 1 addition & 1 deletion docs/kamanda_auth_addUsers.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,4 @@ kamanda auth add-users --src users.json --extension json

* [kamanda auth](kamanda_auth.md) - Perform Firebase Auth Operations

###### Auto generated by spf13/cobra on 17-Apr-2020
###### Auto generated by spf13/cobra on 19-Apr-2020
2 changes: 1 addition & 1 deletion docs/kamanda_auth_customClaims.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ kamanda auth custom-claims [uid1] [uid2] --customClaims "key1:value1" --customCl

* [kamanda auth](kamanda_auth.md) - Perform Firebase Auth Operations

###### Auto generated by spf13/cobra on 17-Apr-2020
###### Auto generated by spf13/cobra on 19-Apr-2020
2 changes: 1 addition & 1 deletion docs/kamanda_auth_deleteUsers.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ kamanda auth delete [uid1] [uid2] [uid3]

* [kamanda auth](kamanda_auth.md) - Perform Firebase Auth Operations

###### Auto generated by spf13/cobra on 17-Apr-2020
###### Auto generated by spf13/cobra on 19-Apr-2020
2 changes: 1 addition & 1 deletion docs/kamanda_auth_find.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ kamanda auth find [UID1] [UID2]
* [kamanda auth find byEmail](kamanda_auth_find_byEmail.md) - Find a Firebase Auth user by email address
* [kamanda auth find byPhone](kamanda_auth_find_byPhone.md) - find a Firebase Auth User by their phone number

###### Auto generated by spf13/cobra on 17-Apr-2020
###### Auto generated by spf13/cobra on 19-Apr-2020
2 changes: 1 addition & 1 deletion docs/kamanda_auth_find_byEmail.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ kamanda auth find by-email [email protected]

* [kamanda auth find](kamanda_auth_find.md) - Find a a Firebase Auth user by their Firebase UID.

###### Auto generated by spf13/cobra on 17-Apr-2020
###### Auto generated by spf13/cobra on 19-Apr-2020
2 changes: 1 addition & 1 deletion docs/kamanda_auth_find_byPhone.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ kamanda auth find by-phone +254712345678

* [kamanda auth find](kamanda_auth_find.md) - Find a a Firebase Auth user by their Firebase UID.

###### Auto generated by spf13/cobra on 17-Apr-2020
###### Auto generated by spf13/cobra on 19-Apr-2020
2 changes: 1 addition & 1 deletion docs/kamanda_auth_users.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ kamanda auth users -output yaml

* [kamanda auth](kamanda_auth.md) - Perform Firebase Auth Operations

###### Auto generated by spf13/cobra on 17-Apr-2020
###### Auto generated by spf13/cobra on 19-Apr-2020
2 changes: 1 addition & 1 deletion docs/kamanda_docsGen.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ kamanda docsGen [flags]

* [kamanda](kamanda.md) - Kamanda is an extender Firebase Tools CLI

###### Auto generated by spf13/cobra on 17-Apr-2020
###### Auto generated by spf13/cobra on 19-Apr-2020
2 changes: 1 addition & 1 deletion docs/kamanda_login.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ kamanda login

* [kamanda](kamanda.md) - Kamanda is an extender Firebase Tools CLI

###### Auto generated by spf13/cobra on 17-Apr-2020
###### Auto generated by spf13/cobra on 19-Apr-2020
2 changes: 1 addition & 1 deletion docs/kamanda_login:ci.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ kamanda login:ci

* [kamanda](kamanda.md) - Kamanda is an extender Firebase Tools CLI

###### Auto generated by spf13/cobra on 17-Apr-2020
###### Auto generated by spf13/cobra on 19-Apr-2020
2 changes: 1 addition & 1 deletion docs/kamanda_logout.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ kamanda logout

* [kamanda](kamanda.md) - Kamanda is an extender Firebase Tools CLI

###### Auto generated by spf13/cobra on 17-Apr-2020
###### Auto generated by spf13/cobra on 19-Apr-2020
2 changes: 1 addition & 1 deletion docs/kamanda_version.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ kamanda version -o json

* [kamanda](kamanda.md) - Kamanda is an extender Firebase Tools CLI

###### Auto generated by spf13/cobra on 17-Apr-2020
###### Auto generated by spf13/cobra on 19-Apr-2020

0 comments on commit 95f68e1

Please sign in to comment.