Updated descriptions of commands and flags (#58)

Author: RevanthTanneeru

cmd/add/account/account.go

@@ -41,8 +41,8 @@ func NewaccountCmd() *cobra.Command {
 	opts.Email = append(opts.Email, *EmailObj)
 	cmd := &cobra.Command{
 		Use:   "account",
-		Short: "add account",
-		Long:  `This commmand adds account`,
+		Short: "Adds an account",
+		Long:  `Use this command to add a user to your application.`,
 		Example: heredoc.Doc(`$ lr add account --name <name> --email <email>
 		User Account  successfully created
 		First name:  <first name>
@@ -60,8 +60,8 @@ func NewaccountCmd() *cobra.Command {
 	}
 
 	fl := cmd.Flags()
-	fl.StringVarP(&opts.Email[0].Value, "email", "e", "", "emailID")
-	fl.StringVarP(&opts.FirstName, "name", "n", "", "first name")
+	fl.StringVarP(&opts.Email[0].Value, "email", "e", "", "Email id of the user you want to add")
+	fl.StringVarP(&opts.FirstName, "name", "n", "", "First name of the user")
 	fl.Lookup("name").NoOptDefVal = ""
 	return cmd
 }

cmd/add/customField/customFields.go

@@ -20,7 +20,7 @@ func NewAddCFCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "custom-field",
 		Short: "Add the custom field which can be used in a registeration schema",
-		Long:  `This command allows you to add upto 5 custom fields to your IDX Page.`,
+		Long:  `Use this command to add up to 5 custom fields to your Auth Page(IDX).`,
 		Example: heredoc.Doc(`$ lr add custom-field -f MyCustomField
 		MyCustomField is successfully add as your customfields
 		You can now add the custom field in your registration schema using "lr set schema" command

cmd/add/domain/domain.go

@@ -32,8 +32,8 @@ func NewdomainCmd() *cobra.Command {
 
 	cmd := &cobra.Command{
 		Use:   "domain",
-		Short: "add doamin",
-		Long:  `This commmand adds domain`,
+		Short: "Adds doamin",
+		Long:  `Use this command to whitelist a domain.`,
 		Example: heredoc.Doc(`$ lr add domain --domain <domain>
 		Your Domain  <newDomain>  is now whitelisted
 		`),
@@ -65,7 +65,7 @@ func NewdomainCmd() *cobra.Command {
 		},
 	}
 	fl := cmd.Flags()
-	fl.StringVarP(&opts.Domain, "domain", "d", "", "Enter Domain Value")
+	fl.StringVarP(&opts.Domain, "domain", "d", "", "Enter Domain Value that you want to add")
 
 	return cmd
 }

cmd/add/hooks/hooks.go

@@ -34,7 +34,7 @@ func NewHooksCmd() *cobra.Command {
 		Use:   "hooks",
 		Short: "Adds hooks",
 		Long: heredoc.Doc(`
-		This command adds webhooks which are configured to an App.
+		Use this command to select a webhook event and then configure a URL to receive the payload.
 		`),
 		Example: heredoc.Doc(`
 			$ lr add hooks

cmd/add/loginMethod/loginMethod.go

@@ -16,7 +16,7 @@ func NewloginMethodCmd() *cobra.Command {
 		Use:   "login-method",
 		Short: "Adds a Login Mathod",
 		Long: heredoc.Doc(`
-		This command adds login methods for your app.
+		Use this command to add the desired login methods for your application.
 		`),
 		Example: heredoc.Doc(`
 			$ lr add login-method

cmd/add/site/site.go

@@ -33,7 +33,7 @@ func NewSiteCmd() *cobra.Command {
 		Use:   "site",
 		Short: "Adds a site",
 		Long: heredoc.Doc(`
-		This command enables user to add a site depending on the subscribed plan. 
+		Use this command to create a new app by specifying the app name and domain and selecting a plan for it.
 		`),
 		Example: heredoc.Doc(`
 			$ lr add site 

cmd/add/social/social.go

@@ -17,8 +17,8 @@ func NewsocialCmd() *cobra.Command {
 
 	cmd := &cobra.Command{
 		Use:   "social",
-		Short: "add social provider",
-		Long:  `This commmand adds social provider`,
+		Short: "Adds a social provider",
+		Long:  `Use this command to select and configure a social login provider for your application.`,
 		Example: `$ lr add social
 		? Select the provider from the list: Facebook
 		Please enter the provider key:

cmd/add/sott/sott.go

@@ -34,7 +34,7 @@ func NewSottCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "sott",
 		Short: "Adds a sott",
-		Long:  `Use this command to add a sott configured for your app.`,
+		Long:  `Use this command to generate a time-bound SOTT.`,
 		Example: heredoc.Doc(`$ lr add sott -f <FromDate(mm/dd/yyyy)> -t <ToDate(mm/dd/yyyy)> 
 		Comment(optional): <value>
 		Select a technology
@@ -63,9 +63,9 @@ func NewSottCmd() *cobra.Command {
 	}
 
 	fl := cmd.Flags()
-	fl.StringVarP(&opts.FromDate, "FromDate", "f", "", "From Date")
+	fl.StringVarP(&opts.FromDate, "FromDate", "f", "", "From Date of the the SOTT")
 
-	fl.StringVarP(&opts.ToDate, "ToDate", "t", "", "To Date")
+	fl.StringVarP(&opts.ToDate, "ToDate", "t", "", "To Date of the SOTT")
 
 	return cmd
 }

cmd/delete/account/account.go

@@ -30,8 +30,8 @@ func NewaccountCmd() *cobra.Command {
 
 	cmd := &cobra.Command{
 		Use:   "account",
-		Short: "delete account",
-		Long:  `This commmand deletes account`,
+		Short: "Delete an account",
+		Long:  `Use this command to delete a user from your app.`,
 		Example: heredoc.Doc(`$ lr delete account --email <email> (or) --uid <uid>
 		User account sucessfully deleted
 		`),
@@ -48,8 +48,8 @@ func NewaccountCmd() *cobra.Command {
 	}
 
 	fl := cmd.Flags()
-	fl.StringVarP(&inpEmail, "email", "e", "", "emailID")
-	fl.StringVarP(&inpUID, "uid", "u", "", "UID")
+	fl.StringVarP(&inpEmail, "email", "e", "", "Email id of the user you want to delete")
+	fl.StringVarP(&inpUID, "uid", "u", "", "UID of the user you want to delete")
 
 	return cmd
 }

cmd/delete/customField/customField.go

@@ -15,8 +15,8 @@ func NewDeleteCFCmd() *cobra.Command {
 
 	cmd := &cobra.Command{
 		Use:   "custom-field",
-		Short: "",
-		Long:  `This commmand deletes the Custom Field`,
+		Short: "Deletes a custom field",
+		Long:  `Use this command to delete a custom field from your Auth Page(IDX). `,
 		Example: heredoc.Doc(`$ lr delete custom-field
 		? Select the field you Want to delete from the list: MyCF
 		? Are you Sure you want to delete this custom field? Yes