docs: add comments explaining the purpose and behavior of config commands

- Add a comment explaining the purpose of the `configCmd` command
- Add a comment explaining the purpose of the `configListCmd` command
- Add a comment explaining the purpose of the `configSetCmd` command
- Add a comment explaining the behavior of the `configListCmd` command

Signed-off-by: appleboy <appleboy.tw@gmail.com>

Author: appleboy

cmd/config.go

@@ -4,6 +4,8 @@ import (
 	"github.com/spf13/cobra"
 )
 
+// configCmd represents the command for custom configuration,
+// including openai.api_key and openai.model and etc...
 var configCmd = &cobra.Command{
 	Use:   "config",
 	Short: "custom config (openai.api_key, openai.model ...)",

cmd/config_list.go

@@ -39,7 +39,10 @@ var availableKeys = map[string]string{
 	"openai.presence_penalty":  "Number between 0.0 and 1.0 that penalizes new tokens based on whether they appear in the text so far. Increases the model's likelihood to talk about new topics.",
 }
 
-// configListCmd represents the config list command
+// configListCmd represents the command to list the configuration values.
+// It creates a table with the header "Key" and "Value" and adds the configuration keys and values to the table.
+// The api key is hidden for security purposes.
+// Finally, it prints the table.
 var configListCmd = &cobra.Command{
 	Use:   "list",
 	Short: "show the config list",

cmd/config_set.go

@@ -13,7 +13,11 @@ func init() {
 	configCmd.AddCommand(configSetCmd)
 }
 
-// configSetCmd represents the config set command
+// configSetCmd updates the config value.
+// It takes at least two arguments, the first one being the key and the second one being the value.
+// If the key is not available, it returns an error message.
+// If the key is "git.exclude_list", it sets the value as a slice of strings.
+// It writes the config to file and prints a success message with the config file location.
 var configSetCmd = &cobra.Command{
 	Use:   "set",
 	Short: "update the config value",