Upd: Update docs, detals

Author: Driver-C

README.md

@@ -31,12 +31,11 @@ Currently, the project only maintains the `master` branch for releasing stable v
 
 ## TODO list
 
-Rankings do not differentiate priority levels.
+Rankings do not differentiate priority levels. Delete the corresponding entry after completion of the following content.
 
 1. File transfer supports wildcards
 2. Completing unit test code
 3. Security-related features, such as encrypting configuration files, hiding sensitive information from plain text display, and switching to interactive password input
-4. Support for key-based authentication
 
 ## Quick Start
 
@@ -76,9 +75,9 @@ Usage:
 
 Available Commands:
   alias       Set, unset, and list aliases, aliases can be used to log in to servers
-  create      Create alternate username, port number, password, and login cache information
-  delete      Delete alternate username, port number, password, and login cache information
-  get         Get alternate username, port number, password, and login cache information
+  create      Create alternative username, port number, password, and login cache information
+  delete      Delete alternative username, port number, password, and login cache information
+  get         Get alternative username, port number, password, and login cache information
   help        Help about any command
   prune       Check if all current caches are available and clear the ones that are not available
   scp         Upload/Download file to/from the server through SSH protocol
@@ -99,16 +98,17 @@ The `"create"` command of `tryssh` is used to create various configurations for
 
 ```
 $ tryssh create -h
-Create alternate username, port number, password, and login cache information
+Create alternative username, port number, password, and login cache information
 
 Usage:
   tryssh create [command]
 
 Available Commands:
-  caches      Create a alternate cache
-  passwords   Create a alternate password
-  ports       Create a alternate port
-  users       Create a alternate username
+  caches      Create an alternative cache
+  keys        Create a alternative key file path
+  passwords   Create an alternative password
+  ports       Create an alternative port
+  users       Create an alternative username
 
 Flags:
   -h, --help   help for create
@@ -137,16 +137,17 @@ The `"delete"` command of `tryssh` is used to delete various configurations for
 
 ```
 $ tryssh delete -h
-Delete alternate username, port number, password, and login cache information
+Delete alternative username, port number, password, and login cache information
 
 Usage:
   tryssh delete [command]
 
 Available Commands:
-  caches      Delete a alternate cache
-  passwords   Delete a alternate password
-  ports       Delete a alternate port
-  users       Delete a alternate username
+  caches      Delete an alternative cache
+  keys        Delete a alternative key file path
+  passwords   Delete an alternative password
+  ports       Delete an alternative port
+  users       Delete an alternative username
 
 Flags:
   -h, --help   help for delete
@@ -178,16 +179,16 @@ The `"get"` command of `tryssh` is used to view various configurations for passw
 
 ```
 $ tryssh get -h
-Get alternate username, port number, password, and login cache information
+Get alternative username, port number, password, and login cache information
 
 Usage:
   tryssh get [command]
 
 Available Commands:
-  caches      Get alternate caches by ipAddress
-  passwords   Get alternate passwords
-  ports       Get alternate ports
-  users       Get alternate usernames
+  caches      Get alternative caches by ipAddress
+  passwords   Get alternative passwords
+  ports       Get alternative ports
+  users       Get alternative usernames
 
 Flags:
   -h, --help   help for get

README_zh.md

@@ -31,12 +31,11 @@
 
 ## 待做清单
 
-排名不区分优先级
+排名不区分优先级，以下内容在完成后删除对应条目
 
 1. 传输文件支持通配符
 2. 完成单元测试代码
 3. 安全相关功能，配置文件加密、隐藏明文显示的敏感信息、密码输入应改为交互式等
-4. 支持秘钥登陆
 
 ## 快速开始
 
@@ -76,9 +75,9 @@ Usage:
 
 Available Commands:
   alias       Set, unset, and list aliases, aliases can be used to log in to servers
-  create      Create alternate username, port number, password, and login cache information
-  delete      Delete alternate username, port number, password, and login cache information
-  get         Get alternate username, port number, password, and login cache information
+  create      Create alternative username, port number, password, and login cache information
+  delete      Delete alternative username, port number, password, and login cache information
+  get         Get alternative username, port number, password, and login cache information
   help        Help about any command
   prune       Check if all current caches are available and clear the ones that are not available
   scp         Upload/Download file to/from the server through SSH protocol
@@ -98,16 +97,17 @@ tryssh 的`create`命令用于创建用来猜密码登陆的各类配置，比
 #### create 帮助信息
 ```
 $ tryssh create -h
-Create alternate username, port number, password, and login cache information
+Create alternative username, port number, password, and login cache information
 
 Usage:
   tryssh create [command]
 
 Available Commands:
-  caches      Create a alternate cache
-  passwords   Create a alternate password
-  ports       Create a alternate port
-  users       Create a alternate username
+  caches      Create an alternative cache
+  keys        Create a alternative key file path
+  passwords   Create an alternative password
+  ports       Create an alternative port
+  users       Create an alternative username
 
 Flags:
   -h, --help   help for create
@@ -136,16 +136,16 @@ tryssh 的`delete`命令用于删除用来猜密码登陆的各类配置，比
 
 ```
 $ tryssh delete -h
-Delete alternate username, port number, password, and login cache information
+Delete alternative username, port number, password, and login cache information
 
 Usage:
   tryssh delete [command]
 
 Available Commands:
-  caches      Delete a alternate cache
-  passwords   Delete a alternate password
-  ports       Delete a alternate port
-  users       Delete a alternate username
+  caches      Delete an alternative cache
+  passwords   Delete an alternative password
+  ports       Delete an alternative port
+  users       Delete an alternative username
 
 Flags:
   -h, --help   help for delete
@@ -177,16 +177,17 @@ tryssh 的`get`命令用于查看用来猜密码登陆的各类配置，比如
 
 ```
 $ tryssh get -h
-Get alternate username, port number, password, and login cache information
+Get alternative username, port number, password, and login cache information
 
 Usage:
   tryssh get [command]
 
 Available Commands:
-  caches      Get alternate caches by ipAddress
-  passwords   Get alternate passwords
-  ports       Get alternate ports
-  users       Get alternate usernames
+  caches      Get alternative caches by ipAddress
+  keys        Delete a alternative key file path
+  passwords   Get alternative passwords
+  ports       Get alternative ports
+  users       Get alternative usernames
 
 Flags:
   -h, --help   help for get

cmd/alias/alias.go

@@ -5,13 +5,13 @@ import (
 )
 
 func NewAliasCommand() *cobra.Command {
-	aliasCmd := &cobra.Command{
+	cmd := &cobra.Command{
 		Use:   "alias <subCommand> [flags]",
 		Short: "Set, unset, and list aliases, aliases can be used to log in to servers",
 		Long:  "Set, unset, and list aliases, aliases can be used to log in to servers",
 	}
-	aliasCmd.AddCommand(NewAliasListCommand())
-	aliasCmd.AddCommand(NewAliasSetCommand())
-	aliasCmd.AddCommand(NewAliasUnsetCommand())
-	return aliasCmd
+	cmd.AddCommand(NewAliasListCommand())
+	cmd.AddCommand(NewAliasSetCommand())
+	cmd.AddCommand(NewAliasUnsetCommand())
+	return cmd
 }

cmd/alias/list.go

@@ -7,16 +7,16 @@ import (
 )
 
 func NewAliasListCommand() *cobra.Command {
-	aliasListCmd := &cobra.Command{
+	cmd := &cobra.Command{
 		Use:     "list",
 		Short:   "List all alias",
 		Long:    "List all alias",
 		Aliases: []string{"ls"},
 		Run: func(cmd *cobra.Command, args []string) {
 			configuration := config.LoadConfig()
-			aliasController := control.NewAliasController("", configuration, "")
-			aliasController.ListAlias()
+			controller := control.NewAliasController("", configuration, "")
+			controller.ListAlias()
 		},
 	}
-	return aliasListCmd
+	return cmd
 }

cmd/alias/set.go

@@ -7,7 +7,7 @@ import (
 )
 
 func NewAliasSetCommand() *cobra.Command {
-	aliasSetCmd := &cobra.Command{
+	cmd := &cobra.Command{
 		Use:   "set <alias> [flags]",
 		Args:  cobra.ExactArgs(1),
 		Short: "Set an alias for the specified server address",
@@ -16,15 +16,15 @@ func NewAliasSetCommand() *cobra.Command {
 			aliasContent := args[0]
 			targetAddress, _ := cmd.Flags().GetString("target")
 			configuration := config.LoadConfig()
-			aliasController := control.NewAliasController(targetAddress, configuration, aliasContent)
-			aliasController.SetAlias()
+			controller := control.NewAliasController(targetAddress, configuration, aliasContent)
+			controller.SetAlias()
 		},
 	}
-	aliasSetCmd.Flags().StringP(
+	cmd.Flags().StringP(
 		"target", "t", "", "Set the alias for the target server address")
-	err := aliasSetCmd.MarkFlagRequired("target")
+	err := cmd.MarkFlagRequired("target")
 	if err != nil {
 		return nil
 	}
-	return aliasSetCmd
+	return cmd
 }

cmd/alias/unset.go

@@ -7,17 +7,17 @@ import (
 )
 
 func NewAliasUnsetCommand() *cobra.Command {
-	aliasUnsetCmd := &cobra.Command{
+	cmd := &cobra.Command{
 		Use:   "unset <alias>",
 		Args:  cobra.ExactArgs(1),
 		Short: "Unset the alias",
 		Long:  "Unset the alias",
 		Run: func(cmd *cobra.Command, args []string) {
 			aliasContent := args[0]
 			configuration := config.LoadConfig()
-			aliasController := control.NewAliasController("", configuration, aliasContent)
-			aliasController.UnsetAlias()
+			controller := control.NewAliasController("", configuration, aliasContent)
+			controller.UnsetAlias()
 		},
 	}
-	return aliasUnsetCmd
+	return cmd
 }

cmd/create/caches.go

@@ -9,10 +9,10 @@ import (
 )
 
 func NewCachesCommand() *cobra.Command {
-	cachesCmd := &cobra.Command{
+	cmd := &cobra.Command{
 		Use:     "caches <cache>",
-		Short:   "Create a alternate cache",
-		Long:    "Create a alternate cache",
+		Short:   "Create an alternative cache",
+		Long:    "Create an alternative cache",
 		Aliases: []string{"cache"},
 		Run: func(cmd *cobra.Command, args []string) {
 			newIp, _ := cmd.Flags().GetString("ip")
@@ -33,31 +33,31 @@ func NewCachesCommand() *cobra.Command {
 				return
 			}
 			configuration := config.LoadConfig()
-			createCtl := control.NewCreateController(control.TypeCaches, string(contentJson), configuration)
-			createCtl.ExecuteCreate()
+			controller := control.NewCreateController(control.TypeCaches, string(contentJson), configuration)
+			controller.ExecuteCreate()
 		},
 	}
-	cachesCmd.Flags().StringP("ip", "i", "", "The ipaddress of the cache to be added")
-	cachesCmd.Flags().StringP("user", "u", "", "The username of the cache to be added")
-	cachesCmd.Flags().StringP("port", "P", "", "The port of the cache to be added")
-	cachesCmd.Flags().StringP("pwd", "p", "", "The password of the cache to be added")
-	cachesCmd.Flags().StringP("alias", "a", "", "The alias of the cache to be added")
+	cmd.Flags().StringP("ip", "i", "", "The ipaddress of the cache to be added")
+	cmd.Flags().StringP("user", "u", "", "The username of the cache to be added")
+	cmd.Flags().StringP("port", "P", "", "The port of the cache to be added")
+	cmd.Flags().StringP("pwd", "p", "", "The password of the cache to be added")
+	cmd.Flags().StringP("alias", "a", "", "The alias of the cache to be added")
 
-	if err := cachesCmd.MarkFlagRequired("ip"); err != nil {
+	if err := cmd.MarkFlagRequired("ip"); err != nil {
 		utils.Logger.Errorln("Flag: ip must be set.")
 		return nil
 	}
-	if err := cachesCmd.MarkFlagRequired("user"); err != nil {
+	if err := cmd.MarkFlagRequired("user"); err != nil {
 		utils.Logger.Errorln("Flag: user must be set.")
 		return nil
 	}
-	if err := cachesCmd.MarkFlagRequired("port"); err != nil {
+	if err := cmd.MarkFlagRequired("port"); err != nil {
 		utils.Logger.Errorln("Flag: port must be set.")
 		return nil
 	}
-	if err := cachesCmd.MarkFlagRequired("pwd"); err != nil {
+	if err := cmd.MarkFlagRequired("pwd"); err != nil {
 		utils.Logger.Errorln("Flag: password must be set.")
 		return nil
 	}
-	return cachesCmd
+	return cmd
 }

cmd/create/create.go

@@ -5,16 +5,16 @@ import (
 )
 
 func NewCreateCommand() *cobra.Command {
-	createCmd := &cobra.Command{
+	cmd := &cobra.Command{
 		Use:     "create [command]",
-		Short:   "Create alternate username, port number, password, and login cache information",
-		Long:    "Create alternate username, port number, password, and login cache information",
+		Short:   "Create alternative username, port number, password, and login cache information",
+		Long:    "Create alternative username, port number, password, and login cache information",
 		Aliases: []string{"cre", "crt", "add"},
 	}
-	createCmd.AddCommand(NewUsersCommand())
-	createCmd.AddCommand(NewPortsCommand())
-	createCmd.AddCommand(NewPasswordsCommand())
-	createCmd.AddCommand(NewCachesCommand())
-	createCmd.AddCommand(NewKeysCommand())
-	return createCmd
+	cmd.AddCommand(NewUsersCommand())
+	cmd.AddCommand(NewPortsCommand())
+	cmd.AddCommand(NewPasswordsCommand())
+	cmd.AddCommand(NewCachesCommand())
+	cmd.AddCommand(NewKeysCommand())
+	return cmd
 }

cmd/create/keys.go

@@ -10,14 +10,14 @@ func NewKeysCommand() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:     "keys <keyFilePath>",
 		Args:    cobra.ExactArgs(1),
-		Short:   "Create a alternate key file path",
-		Long:    "Create a alternate key file path",
+		Short:   "Create an alternative key file path",
+		Long:    "Create an alternative key file path",
 		Aliases: []string{"key"},
 		Run: func(cmd *cobra.Command, args []string) {
 			keyPath := args[0]
 			configuration := config.LoadConfig()
-			ctl := control.NewCreateController(control.TypeKeys, keyPath, configuration)
-			ctl.ExecuteCreate()
+			controller := control.NewCreateController(control.TypeKeys, keyPath, configuration)
+			controller.ExecuteCreate()
 		},
 	}
 	return cmd