run make doc-gen to generate docs

cmd/add.go

@@ -262,6 +262,6 @@ kubecm add -f test.yaml --context-template user,cluster --context-prefix demo
 # Merge test.yaml with $HOME/.kube/config and select the context to be added in interactive mode
 kubecm add -f test.yaml --select-context
 # Add kubeconfig from stdin
-cat /etc/kubernetes/admin.conf |  kubecm add -f -
+cat /etc/kubernetes/admin.conf | kubecm add -f -
 `
 }

cmd/root.go

@@ -68,6 +68,8 @@ func (cli *Cli) setFlags() {
 	}
 	flags := cli.rootCmd.PersistentFlags()
 	flags.StringVar(&cfgFile, "config", kubeconfig, "path of kubeconfig")
+	// let the `make doc-gen` command generate consistent output rather than parsing different $HOME environment variables for different users.
+	flags.Lookup("config").DefValue = "$HOME/.kube/config"
 	flags.IntVarP(&uiSize, "ui-size", "u", 4, "number of list items to show in menu at once")
 	flags.BoolVarP(&silenceTable, "silence-table", "s", false, "enable/disable output of context table on successful config update")
 	flags.BoolVarP(&macNotify, "mac-notify", "m", false, "enable to display Mac notification banner")

docs/en-us/cli/kubecm.md

@@ -21,7 +21,7 @@ KubeConfig Manager.
 ### Options
 
 ```
-      --config string   path of kubeconfig (default "/Users/guoxd/.kube/config")
+      --config string   path of kubeconfig (default "$HOME/.kube/config")
   -h, --help            help for kubecm
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update

docs/en-us/cli/kubecm_add.md

@@ -14,33 +14,36 @@ kubecm add [flags]
 
 ```
 
-Note: If -c is set and more than one context is added to the kubeconfig file, the following will occur:
-- If --context-name is set, the context will be generated as <context-name-0>, <context-name-1> ...
-- If --context-name is not set, it will be generated as <file-name-{hash}> where {hash} is the MD5 hash of the file name.
-
 # Merge test.yaml with $HOME/.kube/config
 kubecm add -f test.yaml 
-# Merge test.yaml with $HOME/.kube/config and rename context name
-kubecm add -cf test.yaml --context-name test
+# Merge test.yaml with $HOME/.kube/config and add a prefix before context name
+kubecm add -cf test.yaml --context-prefix test
+# Merge test.yaml with $HOME/.kube/config and define the attributes used for composing the context name
+kubecm add -f test.yaml --context-template user,cluster
+# Merge test.yaml with $HOME/.kube/config, define the attributes used for composing the context name and add a prefix before context name
+kubecm add -f test.yaml --context-template user,cluster --context-prefix demo
+# Merge test.yaml with $HOME/.kube/config and select the context to be added in interactive mode
+kubecm add -f test.yaml --select-context
 # Add kubeconfig from stdin
-cat /etc/kubernetes/admin.conf |  kubecm add -f -
+cat /etc/kubernetes/admin.conf | kubecm add -f -
 
 ```
 
 ### Options
 
 ```
-      --context-name string   override context name when add kubeconfig context
-  -c, --cover                 Overwrite local kubeconfig files
-  -f, --file string           Path to merge kubeconfig files
-  -h, --help                  help for add
-      --select-context        select the context to be added
+      --context-prefix string      add a prefix before context name
+      --context-template strings   define the attributes used for composing the context name, available values: filename, user, cluster, context, namespace (default [context])
+  -c, --cover                      overwrite local kubeconfig files
+  -f, --file string                path to merge kubeconfig files
+  -h, --help                       help for add
+      --select-context             select the context to be added
 ```
 
 ### Options inherited from parent commands
 
 ```
-      --config string   path of kubeconfig (default "/Users/guoxd/.kube/config")
+      --config string   path of kubeconfig (default "$HOME/.kube/config")
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

docs/en-us/cli/kubecm_add_docs.md

@@ -30,8 +30,8 @@ kubecm add docs
 ### Options inherited from parent commands
 
 ```
-      --config string   path of kubeconfig (default "/Users/guoxd/.kube/config")
-  -c, --cover           Overwrite local kubeconfig files
+      --config string   path of kubeconfig (default "$HOME/.kube/config")
+  -c, --cover           overwrite local kubeconfig files
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

docs/en-us/cli/kubecm_alias.md

@@ -31,7 +31,7 @@ $ kubecm alias -o bash
 ### Options inherited from parent commands
 
 ```
-      --config string   path of kubeconfig (default "/Users/guoxd/.kube/config")
+      --config string   path of kubeconfig (default "$HOME/.kube/config")
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

docs/en-us/cli/kubecm_alias_docs.md

@@ -30,7 +30,7 @@ kubecm add docs
 ### Options inherited from parent commands
 
 ```
-      --config string   path of kubeconfig (default "/Users/guoxd/.kube/config")
+      --config string   path of kubeconfig (default "$HOME/.kube/config")
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

docs/en-us/cli/kubecm_clear.md

@@ -14,7 +14,7 @@ kubecm clear
 
 ```
 
-# Clear lapsed context, cluster and user (default is /Users/guoxd/.kube/config)
+# Clear lapsed context, cluster and user (default is /Users/I576375/.kube/config)
 kubecm clear
 # Customised clear lapsed files
 kubecm clear config.yaml test.yaml
@@ -30,7 +30,7 @@ kubecm clear config.yaml test.yaml
 ### Options inherited from parent commands
 
 ```
-      --config string   path of kubeconfig (default "/Users/guoxd/.kube/config")
+      --config string   path of kubeconfig (default "$HOME/.kube/config")
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

docs/en-us/cli/kubecm_clear_docs.md

@@ -30,7 +30,7 @@ kubecm add docs
 ### Options inherited from parent commands
 
 ```
-      --config string   path of kubeconfig (default "/Users/guoxd/.kube/config")
+      --config string   path of kubeconfig (default "$HOME/.kube/config")
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

docs/en-us/cli/kubecm_cloud.md

@@ -18,7 +18,7 @@ Manage kubeconfig from cloud
 ### Options inherited from parent commands
 
 ```
-      --config string   path of kubeconfig (default "/Users/guoxd/.kube/config")
+      --config string   path of kubeconfig (default "$HOME/.kube/config")
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

docs/en-us/cli/kubecm_cloud_add.md

@@ -60,7 +60,7 @@ kubecm cloud add --provider alibabacloud --cluster_id=xxxxxx
 
 ```
       --cluster_id string   kubernetes cluster id
-      --config string       path of kubeconfig (default "/Users/guoxd/.kube/config")
+      --config string       path of kubeconfig (default "$HOME/.kube/config")
   -m, --mac-notify          enable to display Mac notification banner
       --provider string     public cloud
       --region_id string    cloud region id

docs/en-us/cli/kubecm_cloud_docs.md

@@ -31,7 +31,7 @@ kubecm add docs
 
 ```
       --cluster_id string   kubernetes cluster id
-      --config string       path of kubeconfig (default "/Users/guoxd/.kube/config")
+      --config string       path of kubeconfig (default "$HOME/.kube/config")
   -m, --mac-notify          enable to display Mac notification banner
       --provider string     public cloud
       --region_id string    cloud region id

docs/en-us/cli/kubecm_cloud_list.md

@@ -45,7 +45,7 @@ kubecm cloud list --provider alibabacloud --cluster_id=xxxxxx
 
 ```
       --cluster_id string   kubernetes cluster id
-      --config string       path of kubeconfig (default "/Users/guoxd/.kube/config")
+      --config string       path of kubeconfig (default "$HOME/.kube/config")
   -m, --mac-notify          enable to display Mac notification banner
       --provider string     public cloud
       --region_id string    cloud region id

docs/en-us/cli/kubecm_create.md

@@ -38,7 +38,7 @@ kubecm create --user test --namespace default --cluster-role view --context-name
 ### Options inherited from parent commands
 
 ```
-      --config string   path of kubeconfig (default "/Users/guoxd/.kube/config")
+      --config string   path of kubeconfig (default "$HOME/.kube/config")
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

docs/en-us/cli/kubecm_delete.md

@@ -32,7 +32,7 @@ kubecm delete my-context1 my-context2
 ### Options inherited from parent commands
 
 ```
-      --config string   path of kubeconfig (default "/Users/guoxd/.kube/config")
+      --config string   path of kubeconfig (default "$HOME/.kube/config")
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

docs/en-us/cli/kubecm_delete_docs.md

@@ -30,7 +30,7 @@ kubecm add docs
 ### Options inherited from parent commands
 
 ```
-      --config string   path of kubeconfig (default "/Users/guoxd/.kube/config")
+      --config string   path of kubeconfig (default "$HOME/.kube/config")
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

docs/en-us/cli/kubecm_docs.md

@@ -30,7 +30,7 @@ kubecm add docs
 ### Options inherited from parent commands
 
 ```
-      --config string   path of kubeconfig (default "/Users/guoxd/.kube/config")
+      --config string   path of kubeconfig (default "$HOME/.kube/config")
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

docs/en-us/cli/kubecm_export.md

@@ -31,7 +31,7 @@ kubecm export -f myconfig.yaml my-context1 my-context2
 ### Options inherited from parent commands
 
 ```
-      --config string   path of kubeconfig (default "/Users/guoxd/.kube/config")
+      --config string   path of kubeconfig (default "$HOME/.kube/config")
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

docs/en-us/cli/kubecm_export_docs.md

@@ -30,7 +30,7 @@ kubecm add docs
 ### Options inherited from parent commands
 
 ```
-      --config string   path of kubeconfig (default "/Users/guoxd/.kube/config")
+      --config string   path of kubeconfig (default "$HOME/.kube/config")
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

docs/en-us/cli/kubecm_list.md

@@ -33,7 +33,7 @@ kubecm ls kind k3s
 ### Options inherited from parent commands
 
 ```
-      --config string   path of kubeconfig (default "/Users/guoxd/.kube/config")
+      --config string   path of kubeconfig (default "$HOME/.kube/config")
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

docs/en-us/cli/kubecm_list_docs.md

@@ -30,7 +30,7 @@ kubecm add docs
 ### Options inherited from parent commands
 
 ```
-      --config string   path of kubeconfig (default "/Users/guoxd/.kube/config")
+      --config string   path of kubeconfig (default "$HOME/.kube/config")
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

docs/en-us/cli/kubecm_merge.md

@@ -20,22 +20,32 @@ kubecm merge 1st.yaml 2nd.yaml 3rd.yaml
 kubecm merge -f dir
 # Merge KubeConfig in the dir directory to the specified file.
 kubecm merge -f dir --config kubecm.config
+# Merge test.yaml with $HOME/.kube/config and add a prefix before context name
+kubecm merge test.yaml --context-prefix test
+# Merge test.yaml with $HOME/.kube/config and define the attributes used for composing the context name
+kubecm merge test.yaml --context-template user,cluster
+# Merge test.yaml with $HOME/.kube/config, define the attributes used for composing the context name and add a prefix before context name
+kubecm merge test.yaml --context-template user,cluster --context-prefix demo
+# Merge test.yaml with $HOME/.kube/config and select the context to be added in interactive mode
+kubecm merge test.yaml --select-context
 
 ```
 
 ### Options
 
 ```
-  -y, --assumeyes       skip interactive file overwrite confirmation
-  -f, --folder string   KubeConfig folder
-  -h, --help            help for merge
-      --select-context  select the context to be merged
+  -y, --assumeyes                  skip interactive file overwrite confirmation
+      --context-prefix string      add a prefix before context name
+      --context-template strings   define the attributes used for composing the context name, available values: filename, user, cluster, context, namespace (default [context])
+  -f, --folder string              KubeConfig folder
+  -h, --help                       help for merge
+      --select-context             select the context to be merged
 ```
 
 ### Options inherited from parent commands
 
 ```
-      --config string   path of kubeconfig (default "/Users/guoxd/.kube/config")
+      --config string   path of kubeconfig (default "$HOME/.kube/config")
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

docs/en-us/cli/kubecm_merge_docs.md

@@ -30,7 +30,7 @@ kubecm add docs
 ### Options inherited from parent commands
 
 ```
-      --config string   path of kubeconfig (default "/Users/guoxd/.kube/config")
+      --config string   path of kubeconfig (default "$HOME/.kube/config")
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

docs/en-us/cli/kubecm_rename.md

@@ -28,7 +28,7 @@ kubecm rename
 ### Options inherited from parent commands
 
 ```
-      --config string   path of kubeconfig (default "/Users/guoxd/.kube/config")
+      --config string   path of kubeconfig (default "$HOME/.kube/config")
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

docs/en-us/cli/kubecm_rename_docs.md

@@ -30,7 +30,7 @@ kubecm add docs
 ### Options inherited from parent commands
 
 ```
-      --config string   path of kubeconfig (default "/Users/guoxd/.kube/config")
+      --config string   path of kubeconfig (default "$HOME/.kube/config")
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

docs/en-us/cli/kubecm_switch.md

@@ -32,7 +32,7 @@ kubecm switch dev
 ### Options inherited from parent commands
 
 ```
-      --config string   path of kubeconfig (default "/Users/guoxd/.kube/config")
+      --config string   path of kubeconfig (default "$HOME/.kube/config")
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

docs/en-us/cli/kubecm_switch_docs.md

@@ -30,7 +30,7 @@ kubecm add docs
 ### Options inherited from parent commands
 
 ```
-      --config string   path of kubeconfig (default "/Users/guoxd/.kube/config")
+      --config string   path of kubeconfig (default "$HOME/.kube/config")
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)

docs/en-us/cli/kubecm_version.md

@@ -19,7 +19,7 @@ kubecm version [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   path of kubeconfig (default "/Users/guoxd/.kube/config")
+      --config string   path of kubeconfig (default "$HOME/.kube/config")
   -m, --mac-notify      enable to display Mac notification banner
   -s, --silence-table   enable/disable output of context table on successful config update
   -u, --ui-size int     number of list items to show in menu at once (default 4)