Home

Awesome

k3d plugin for Oh My Zsh

This plugin adds completion for k3d, as well as some aliases for common k3d commands.

It was heavily borrowed from the kubectl plugin that comes installed with oh-my-zsh out of the box. The kubectl plugin source can be found here: https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/kubectl

Installation

First, make sure you have zsh and oh-my-zsh installed. You can find those instructions here: https://github.com/ohmyzsh/ohmyzsh/wiki

Next, to install this plugin, clone this repo to ~/.oh-my-zsh/custom/plugins:

git clone https://github.com/dwaynebradley/k3d-oh-my-zsh-plugin.git ~/.oh-my-zsh/custom/plugins/k3d

Finally, to use the plugin, add k3d to the plugins array in your ~./zshrc file:

plugins=(... k3d)

Aliases

AliasCommandDescription
k3d cluster aliases
k3dcck3d cluster createCreate a new cluster
k3dcdk3d cluster deleteDelete cluster(s)
k3dcdk3d cluster editEdit cluster(s)
k3dclk3d cluster listList cluster(s)
k3dcsk3d cluster startStart existing k3d cluster(s)
k3dcpk3d cluster stopStop existing k3d cluster(s)
k3d config aliases
k3dcoik3d config init
k3dcomk3d config migrate
k3d image aliases
k3diik3d image importImport image(s) from docker into k3d cluster(s)
k3d kubeconfig aliases
k3dcoik3d kubeconfig getPrint kubeconfig(s) from cluster(s)
k3dcomk3d kubeconfig mergeWrite/Merge kubeconfig(s) from cluster(s) into new or existing kubeconfig/file
k3d node aliases
k3dnck3d node createCreate a new k3s node in docker
k3dndk3d node deleteDelete node(s)
k3dndk3d node editEdit node(s)
k3dnlk3d node listList node(s)
k3dnsk3d node startStart existing k3d node
k3dnpk3d node stopStop existing k3d node
k3d registry aliases
k3drck3d registry createCreate a new registry
k3drdk3d registry deleteDelete registry/registries
k3drlk3d registry listList registries
k3d version alias
k3dvk3d versionShow k3d and default k3s version
k3d help alias
k3dhk3d helpHelp about any command