Shell Completion¶

Assuming the Kyverno Authz Server is installed locally, you can easily enable shell completion support for Bash, Zsh, Fish, and PowerShell.

Once set up, you can use the key to auto-complete commands, flags, and even some arguments, which significantly improves the command-line experience.

Generating Completion Scripts¶

You can generate shell completion scripts using the kyverno-envoy-plugin completion command:

# For Bash
kyverno-envoy-plugin completion bash

# For Zsh
kyverno-envoy-plugin completion zsh

# For Fish
kyverno-envoy-plugin completion fish

# For PowerShell
kyverno-envoy-plugin completion powershell

Setting Up Completion¶

Bash¶

To enable completion in your current Bash session:

source <(kyverno-envoy-plugin completion bash)

To enable completion for all sessions, add the above line to your ~/.bashrc file:

echo 'source <(kyverno-envoy-plugin completion bash)' >> ~/.bashrc

Alternatively, you can save the completion script to the bash-completion directory:

# On Linux
kyverno-envoy-plugin completion bash > /etc/bash_completion.d/kyverno-envoy-plugin

# On macOS with Homebrew
kyverno-envoy-plugin completion bash > $(brew --prefix)/etc/bash_completion.d/kyverno-envoy-plugin

Zsh¶

To enable completion in your current Zsh session:

source <(kyverno-envoy-plugin completion zsh)

To enable completion for all sessions, add the above line to your ~/.zshrc file:

echo 'source <(kyverno-envoy-plugin completion zsh)' >> ~/.zshrc

Alternatively, you can save the completion script to a directory in your $fpath:

# Create a directory for completions if it doesn't exist
mkdir -p ~/.zsh/completion
# Generate and save the completion script
kyverno-envoy-plugin completion zsh > ~/.zsh/completion/_kyverno-envoy-plugin

# Make sure the directory is in your fpath by adding to ~/.zshrc:
echo 'fpath=(~/.zsh/completion $fpath)' >> ~/.zshrc
echo 'autoload -U compinit; compinit' >> ~/.zshrc

Fish¶

To enable completion in Fish:

kyverno-envoy-plugin completion fish > ~/.config/fish/completions/kyverno-envoy-plugin.fish

PowerShell¶

To enable completion in PowerShell:

kyverno-envoy-plugin completion powershell | Out-String | Invoke-Expression

To make it persistent, add the above line to your PowerShell profile:

# Find the profile path
echo $PROFILE

# Add the completion command to your profile
kyverno-envoy-plugin completion powershell | Out-String | Out-File -Append $PROFILE

Testing Completion¶

After setting up completion, you can test it by typing kyverno-envoy-plugin followed by a space and pressing . This should show available subcommands. You can also try typing partial commands like kyverno-envoy-plugin se and then pressing , which should complete to kyverno-envoy-plugin serve.

Detailed Reference¶

For more detailed information about each completion command, see the reference documentation: