Add Examples to Commands Usage

mainawycliffe · Apr 17, 2020 · be46077 · be46077
1 parent 55c3c0a
commit be46077
Show file tree

Hide file tree

Showing 7 changed files with 33 additions and 5 deletions.
diff --git a/cmd/login:ci.go b/cmd/login:ci.go
@@ -10,8 +10,9 @@ import (
 
 // loginCICmd represents the login:ci command
 var loginCICmd = &cobra.Command{
-	Use:   "login:ci",
-	Short: "generate an access token for use in non-interactive environments",
+	Use:     "login:ci",
+	Short:   "generate an access token for use in non-interactive environments",
+	Example: "kamanda login:ci",
 	Run: func(cmd *cobra.Command, args []string) {
 		noLocalhostFlag, _ := cmd.Flags().GetBool("no-localhost")
 		if !noLocalhostFlag {

diff --git a/cmd/logout.go b/cmd/logout.go
@@ -13,8 +13,9 @@ import (
 
 // logoutCmd represents the logout command
 var logoutCmd = &cobra.Command{
-	Use:   "logout",
-	Short: "Logout kamanda from Firebase",
+	Use:     "logout",
+	Short:   "Logout kamanda from Firebase",
+	Example: "kamanda logout",
 	Run: func(cmd *cobra.Command, args []string) {
 		email := viper.GetString(configs.FirebaseLoggedInUserEmailViperConfigKey)
 		if !viper.IsSet(configs.FirebaseRefreshTokenViperConfigKey) {

diff --git a/cmd/version.go b/cmd/version.go
@@ -24,6 +24,7 @@ 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",
 	Run: func(cmd *cobra.Command, args []string) {
 		output, err := cmd.Flags().GetString("output")
 		if err != nil {

diff --git a/docs/kamanda_login.md b/docs/kamanda_login.md
@@ -4,12 +4,19 @@ Log kamanda into firebase
 
 ### Synopsis
 
-Log kamanda into firebase
+This allows Kamanda to administer your Firebase Project. 
+You can use --no-localhost flag if you are on environment without a browser.
 
 ```
 kamanda login [flags]
 ```
 
+### Examples
+
+```
+kamanda login
+```
+
 ### Options
 
 ```

diff --git a/docs/kamanda_login:ci.md b/docs/kamanda_login:ci.md
@@ -10,6 +10,12 @@ generate an access token for use in non-interactive environments
 kamanda login:ci [flags]
 ```
 
+### Examples
+
+```
+kamanda login:ci
+```
+
 ### Options
 
 ```

diff --git a/docs/kamanda_logout.md b/docs/kamanda_logout.md
@@ -10,6 +10,12 @@ Logout kamanda from Firebase
 kamanda logout [flags]
 ```
 
+### Examples
+
+```
+kamanda logout
+```
+
 ### Options
 
 ```

diff --git a/docs/kamanda_version.md b/docs/kamanda_version.md
@@ -10,6 +10,12 @@ Version will output the current build information
 kamanda version [flags]
 ```
 
+### Examples
+
+```
+kamanda version or kamanda version -o json
+```
+
 ### Options
 
 ```