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

Commit

Permalink
Update Command Examples and Long Description
Browse files Browse the repository at this point in the history
  • Loading branch information
mainawycliffe committed Apr 17, 2020
1 parent 499aecf commit f88c849
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 7 deletions.
10 changes: 8 additions & 2 deletions cmd/listUsers.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,14 @@ import (
// listUsersCmd represents the listUsers command
var listUsersCmd = &cobra.Command{
Use: "users",
Aliases: []string{"list", "listUsers"},
Short: "Get a list of users in firebase auth.",
Aliases: []string{"list", "listUsers", "list-users"},
Short: "Fetch and display a list of users in firebase auth.",
Long: `This fetches users on Firebase Auth and either outputs it in either table, json or yaml format.
In cases where there are more than 500 users, you will also get a nextPageToken, that you can use to fetch more users.`,
Example: `kamanda auth users
kamanda auth users -o json
kamanda auth users -output yaml`,
Run: func(cmd *cobra.Command, args []string) {
output, err := cmd.Flags().GetString("output")
if err != nil {
Expand Down
3 changes: 2 additions & 1 deletion cmd/version.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ var versionCmd = &cobra.Command{
Use: "version",
Aliases: []string{"v"},
Short: "Version will output the current build information",
Example: "kamanda version or kamanda version -o json",
Example: `kamanda version
kamanda version -o json`,
Run: func(cmd *cobra.Command, args []string) {
output, err := cmd.Flags().GetString("output")
if err != nil {
Expand Down
2 changes: 1 addition & 1 deletion docs/kamanda_auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,6 @@ Perform Firebase Auth Operations
* [kamanda auth customClaims](kamanda_auth_customClaims.md) - Add custom claims to an existing firebase user or users through their UIDs
* [kamanda auth deleteUsers](kamanda_auth_deleteUsers.md) - Delete multiple Firebase Auth User by their UID
* [kamanda auth find](kamanda_auth_find.md) - Find a a Firebase Auth user by their Firebase UID.
* [kamanda auth users](kamanda_auth_users.md) - Get a list of users in firebase auth.
* [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
14 changes: 12 additions & 2 deletions docs/kamanda_auth_users.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,25 @@
## kamanda auth users

Get a list of users in firebase auth.
Fetch and display a list of users in firebase auth.

### Synopsis

Get a list of users in firebase auth.
This fetches users on Firebase Auth and either outputs it in either table, json or yaml format.

In cases where there are more than 500 users, you will also get a nextPageToken, that you can use to fetch more users.

```
kamanda auth users [flags]
```

### Examples

```
kamanda auth users
kamanda auth users -o json
kamanda auth users -output yaml
```

### Options

```
Expand Down
3 changes: 2 additions & 1 deletion docs/kamanda_version.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ kamanda version [flags]
### Examples

```
kamanda version or kamanda version -o json
kamanda version
kamanda version -o json
```

### Options
Expand Down

0 comments on commit f88c849

Please sign in to comment.