From d1c04555f4e3b5789ada933ce1a0df36db7851e2 Mon Sep 17 00:00:00 2001 From: Ahmet Alp Balkan Date: Wed, 26 Apr 2017 09:49:46 -0700 Subject: [PATCH] Update readmes Signed-off-by: Ahmet Alp Balkan --- README.md | 20 ++++++++++++++++---- completion/README.md | 45 -------------------------------------------- 2 files changed, 16 insertions(+), 49 deletions(-) delete mode 100644 completion/README.md diff --git a/README.md b/README.md index b31627c..880b3e9 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ USAGE: Purpose of this project is to provide an utility and facilitate discussion about how `kubectl` can manage contexts better. -## Example +## Usage ```sh $ kubectx minikube @@ -31,11 +31,23 @@ Context "dublin" set. Aliased "gke_ahmetb_europe-west1-b_dublin" as "dublin". ``` -[Set up `bash` and `zsh` completion →](completion/README.md) +`kubectx` also supports Tab completion, which helps with long context +names. -### Help wanted +## Installation -- [ ] homebrew formula/tap that installs the script and completions +For macOS: + +> Use [Homebrew](https://brew.sh/) package manager: +> +> brew tap ahmetb/kubectx https://github.com/ahmetb/kubectx.git +> brew install kubectx +> this will also set up bash/zsh completion scripts automatically. + +Other platforms: + +> Download the `kubectx` script, make it executable and add it to your PATH. You +> can also install bash/zsh [completion scripts](completion/) manually. ----- diff --git a/completion/README.md b/completion/README.md deleted file mode 100644 index fe4bba9..0000000 --- a/completion/README.md +++ /dev/null @@ -1,45 +0,0 @@ -kubectx provides shell completion scripts to complete context names, making it -even faster to switch between contexts easily. - -## Bash setup - -Copy the `kubectx.bash` file to your HOME directory: - -```sh -cp kubectx.bash ~/.kubectx.bash -``` - -And source it in your `~/.bashrc` file by adding the line: - -```sh -[ -f ~/.kubectx.bash ] && source ~/.kubectx.bash -``` - -Start a new shell, type `kubectx`, then hit Tab to see the existing -contexts. - -You can Add `TAB: menu-complete` to your `~/.inputrc` to cycle through the -options with Tab. - -## Zsh setup - -`zsh` can leverage the `bash` completion scripts. Copy the `kubectx.bash` file -to your HOME directory: - -```sh -cp kubectx.bash ~/.kubectx.bash -``` - -And add the following to your `.zshrc`: - -```sh -[ -f ~/.kubectx.bash ] && source ~/.kubectx.bash -``` - -Start a new shell, type `kubectx`, then hit Tab to see the existing -contexts. If it does not work, modify the line above to: - -```sh -[ -f ~/.kubectx.bash ] && autoload bashcompinit && bashcompinit && \ - source ~/.kubectx.bash -```