/oh-my-kustomize

Oh My ZSH Kustomize Plugin

Primary LanguageShellMIT LicenseMIT

Kustomize Oh My ZSH Plugin

This Oh My ZSH plugin adds completion for Kustomize, the Kubernetes native configuration management tool, as well as some useful aliases for common commands.

To use this plugin:

  1. Install the plugin:
git clone https://github.com/ralgozino/oh-my-kustomize ~/.oh-my-zsh/plugins/kustomize

or in your custom plugins folder:

git clone https://github.com/ralgozino/oh-my-kustomize ~/.oh-my-zsh/custom/plugins/kustomize
  1. Add kustomize to the plugins array in your .zshrc file:
plugins=(... kustomize)
  1. Open a new shell or source your .zshrc file.

💡 Notice that Kustomize changed the command to generate the command completinos in v3.8.6.

For versions 3.8.5 or earlier you'll need to activate the command completion manualy by running:

kustomize install-completions

Aliases

Alias Command Description
kz kustomize Runs kustomize, you can pass the subcomands you want, i.e. kz build
kzb kustomize build Runs kustoimze build, you can pass more flags and argunments to the command, like the folder.
kzby kustomize build <args> | yh Will run kustomize build and pipe the output to yh for YAML formatting.
kzba kustomize build <args> | kubectl apply -f - Will run kustomize build and pipe the output to kubectl apply.
kzbas kustomize build <args> | kubectl apply -f - --server-side Will run kustomize build and pipe the output to kubectl apply --server-side.
kzbasf kustomize build <args> | kubectl apply -f - --server-side --force-conflicts Will run kustomize build and pipe the output to kubectl apply --server-side --froce-conflicts.
kzc kustomize create Runs kustomize create
kzca kustomize create Runs kustomize create --autodetect
kzcar kustomize create Runs kustomize create --autodetect --recursive
kze kustomize edit Runs kustomize edit
kzv kustomize version Runs kustomize version

Honorable mention

This plugin is heavily based on the official oh-my-zsh kubectl plugin.