diff --git a/cmd/listUsers.go b/cmd/listUsers.go index efe1812..20a26cf 100644 --- a/cmd/listUsers.go +++ b/cmd/listUsers.go @@ -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 { diff --git a/cmd/version.go b/cmd/version.go index 8e20700..11194d9 100644 --- a/cmd/version.go +++ b/cmd/version.go @@ -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 { diff --git a/docs/kamanda_auth.md b/docs/kamanda_auth.md index 323de6b..2005221 100644 --- a/docs/kamanda_auth.md +++ b/docs/kamanda_auth.md @@ -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 diff --git a/docs/kamanda_auth_users.md b/docs/kamanda_auth_users.md index 2e4215a..9bb70a4 100644 --- a/docs/kamanda_auth_users.md +++ b/docs/kamanda_auth_users.md @@ -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 ``` diff --git a/docs/kamanda_version.md b/docs/kamanda_version.md index ec3f9c6..2836a44 100644 --- a/docs/kamanda_version.md +++ b/docs/kamanda_version.md @@ -13,7 +13,8 @@ kamanda version [flags] ### Examples ``` -kamanda version or kamanda version -o json +kamanda version +kamanda version -o json ``` ### Options