Document --with-short-names

Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>
This commit is contained in:
Ahmet Alp Balkan 2017-05-16 22:05:52 -07:00
parent a376b02e88
commit 8dec9cf004
No known key found for this signature in database
GPG Key ID: 5C02521D7B216AD6

View File

@ -72,7 +72,7 @@ names.
## Installation ## Installation
For macOS: **For macOS:**
> Use [Homebrew](https://brew.sh/) package manager: > Use [Homebrew](https://brew.sh/) package manager:
> >
@ -80,7 +80,10 @@ For macOS:
> brew install kubectx > brew install kubectx
> this will also set up bash/zsh completion scripts automatically. > this will also set up bash/zsh completion scripts automatically.
Other platforms: Running `brew install` with `--with-short-names` will install tools with names
`kctx` and `kns` to prevent prefix collision with `kubectl` name.
**Other platforms:**
> Download the `kubectx` script, make it executable and add it to your PATH. You > Download the `kubectx` script, make it executable and add it to your PATH. You
> can also install bash/zsh [completion scripts](completion/) manually. > can also install bash/zsh [completion scripts](completion/) manually.