update docs (#74)

sunny0826 · Nov 15, 2021 · 9706952 · 9706952
1 parent fbd4e76
commit 9706952
Show file tree

Hide file tree

Showing 4 changed files with 77 additions and 39 deletions.
diff --git a/docs/en-us/cli/kubecm.md b/docs/en-us/cli/kubecm.md
@@ -34,5 +34,3 @@ Find more information at: https://github.com/sunny0826/kubecm
 * [kubecm rename](kubecm_rename.md)	 - Rename the contexts of kubeconfig
 * [kubecm switch](kubecm_switch.md)	 - Switch Kube Context interactively
 * [kubecm version](kubecm_version.md)	 - Print version info
-
-###### Auto generated by spf13/cobra on 18-Nov-2020
diff --git a/docs/en-us/cli/kubecm_completion.md b/docs/en-us/cli/kubecm_completion.md
@@ -1,32 +1,51 @@
 ## kubecm completion
 
-Generates bash/zsh completion scripts
+Generate completion script
 
 ### Synopsis
 
-Output shell completion code for the specified shell (bash or zsh).
+To load completions:
 
-```
-kubecm completion [flags]
-```
+Bash:
 
-### Examples
+$ source <(kubecm completion bash)
 
-```
+# To load completions for each session, execute once:
+# Linux:
+$ kubecm completion bash > /etc/bash_completion.d/kubecm
+# macOS:
+$ kubecm completion bash > /usr/local/etc/bash_completion.d/kubecm
+
+Zsh:
+
+# If shell completion is not already enabled in your environment,
+# you will need to enable it.  You can execute the following once:
+
+$ echo "autoload -U compinit; compinit" >> ~/.zshrc
+
+# To load completions for each session, execute once:
+$ kubecm completion zsh > "${fpath[1]}/_kubecm"
+
+# You will need to start a new shell for this setup to take effect.
 
-# bash
-kubecm completion bash > ~/.kube/kubecm.bash.inc
-printf "
-# kubecm shell completion
-source '$HOME/.kube/kubecm.bash.inc'
-" >> $HOME/.bash_profile
-source $HOME/.bash_profile
+fish:
 
-# add to $HOME/.zshrc
-source <(kubecm completion zsh)
-# or
-kubecm completion zsh > "${fpath[1]}/_kubecm"
+$ kubecm completion fish | source
 
+# To load completions for each session, execute once:
+$ kubecm completion fish > ~/.config/fish/completions/kubecm.fish
+
+PowerShell:
+
+PS> kubecm completion powershell | Out-String | Invoke-Expression
+
+# To load completions for every new session, run:
+PS> kubecm completion powershell > kubecm.ps1
+# and source this file from your PowerShell profile.
+
+
+```
+kubecm completion [bash|zsh|fish|powershell] [flags]
 ```
 
 ### Options
@@ -40,3 +59,7 @@ kubecm completion zsh > "${fpath[1]}/_kubecm"
 ```
       --config string   path of kubeconfig (default "/Users/guoxudong/.kube/config")
 ```
+
+### SEE ALSO
+
+* [kubecm](kubecm.md)	 - KubeConfig Manager.
diff --git a/docs/zh-cn/cli/kubecm.md b/docs/zh-cn/cli/kubecm.md
@@ -34,5 +34,3 @@ Find more information at: https://github.com/sunny0826/kubecm
 * [kubecm rename](kubecm_rename.md)	 - Rename the contexts of kubeconfig
 * [kubecm switch](kubecm_switch.md)	 - Switch Kube Context interactively
 * [kubecm version](kubecm_version.md)	 - Print version info
-
-###### Auto generated by spf13/cobra on 18-Nov-2020
diff --git a/docs/zh-cn/cli/kubecm_completion.md b/docs/zh-cn/cli/kubecm_completion.md
@@ -4,29 +4,48 @@
 
 ### 简介
 
-输出自动补全脚本（bash 或 zsh）
+To load completions:
 
-```
-kubecm completion [flags]
-```
+Bash:
 
-### 示例
+$ source <(kubecm completion bash)
 
-```
+# To load completions for each session, execute once:
+# Linux:
+$ kubecm completion bash > /etc/bash_completion.d/kubecm
+# macOS:
+$ kubecm completion bash > /usr/local/etc/bash_completion.d/kubecm
+
+Zsh:
+
+# If shell completion is not already enabled in your environment,
+# you will need to enable it.  You can execute the following once:
+
+$ echo "autoload -U compinit; compinit" >> ~/.zshrc
+
+# To load completions for each session, execute once:
+$ kubecm completion zsh > "${fpath[1]}/_kubecm"
 
-# bash
-kubecm completion bash > ~/.kube/kubecm.bash.inc
-printf "
-# kubecm shell completion
-source '$HOME/.kube/kubecm.bash.inc'
-" >> $HOME/.bash_profile
-source $HOME/.bash_profile
+# You will need to start a new shell for this setup to take effect.
 
-# add to $HOME/.zshrc
-source <(kubecm completion zsh)
-# or
-kubecm completion zsh > "${fpath[1]}/_kubecm"
+fish:
 
+$ kubecm completion fish | source
+
+# To load completions for each session, execute once:
+$ kubecm completion fish > ~/.config/fish/completions/kubecm.fish
+
+PowerShell:
+
+PS> kubecm completion powershell | Out-String | Invoke-Expression
+
+# To load completions for every new session, run:
+PS> kubecm completion powershell > kubecm.ps1
+# and source this file from your PowerShell profile.
+
+
+```
+kubecm completion [bash|zsh|fish|powershell] [flags]
 ```
 
 ### 选项