15308555518/ kubekey
1
0
Fork 0
mirror of https://github.com/kubesphere/kubekey.git synced 2025-12-26 01:22:51 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve the documentation for kk bash completion 

Signed-off-by: rick <1450685+LinuxSuRen@users.noreply.github.com>
This commit is contained in:
rick 2021-03-12 09:04:39 +08:00
parent 7f9d57dc52
commit 7fd5000413
No known key found for this signature in database
GPG Key ID: 4DF7126098031BD3
3 changed files with 39 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -275,7 +275,8 @@ Getting cluster info and generating kubekey's configuration file (optional).
* [Addons](docs/addons.md)
* [Network access](docs/network-access.md)
* [Storage clients](docs/storage-client.md)
* [Kubectl autocompletion](docs/kubectl-autocompletion.md)
* [kubectl auto-completion](docs/kubectl-autocompletion.md)
* [kubekey auto-completion](docs/kubekey-autocompletion.md)
* [Roadmap](docs/roadmap.md)
* [Check-Renew-Certificate](docs/check-renew-certificate.md)
* [Developer-Guide](docs/developer-guide.md)

23
cmd/completion.go
View File

@ -54,17 +54,18 @@ var completionCmd = &cobra.Command{
Short: "Generate shell completion scripts",
Long: `Generate shell completion scripts
Normally you don't need to do more extra work to have this feature if you've installed kk by brew`,
Example: `Installing bash completion on macOS using homebrew
If running Bash 3.2 included with macOS
brew install bash-completion
or, if running Bash 4.1+
brew install bash-completion@2
You may need to add the completion to your completion directory by the following command
kk completion > $(brew --prefix)/etc/bash_completion.d/kk
If you get trouble, please visit https://github.com/jenkins-zh/jenkins-cli/issues/83.
Load kk completion code for bash into the current shell
source <(kk completion --type bash)
Example: `# Installing bash completion on Linux
## If bash-completion is not installed on Linux, please install the 'bash-completion' package
## via your distribution's package manager.
## Load the ks completion code for bash into the current shell
source <(ks completion bash)
## Write bash completion code to a file and source if from .bash_profile
mkdir -p ~/.config/kk/ && kk completion --type bash > ~/.config/kk/completion.bash.inc
printf "
# kk shell completion
source '$HOME/.config/kk/completion.bash.inc'
" >> $HOME/.bash_profile
source $HOME/.bash_profile
In order to have good experience on zsh completion, ohmyzsh is a good choice.
Please install ohmyzsh by the following command

25
docs/kubekey-autocompletion.md Normal file
View File

@ -0,0 +1,25 @@
Enable kubekey auto-completion
------------
**Prerequisite**: make sure `bash-completion` is installed and does workk.
## Bash Completion
You can install it via your distribution's package manager.
For Ubuntu, `apt-get install bash-completion`
For CentOS, `yum install -y bash-completion`
## Setup Completion
Write bash completion code to a file and source if from .bash_profile.
```
mkdir -p ~/.config/kk/ && kk completion bash > ~/.config/kk/completion.bash.inc
printf "
# kk shell completion
source '$HOME/.config/kk/completion.bash.inc'
" >> $HOME/.bash_profile
source $HOME/.bash_profile
```