How to Add Shell Completion (Bash, Zsh, Fish) to a Go CLI

Use the cobra library to generate shell completion scripts for Bash, Zsh, and Fish by running the completion command for each shell. Add the generated script to your shell's configuration directory and source it to enable completions.

# Generate and install Bash completion
mycli completion bash > /etc/bash_completion.d/mycli

# Generate and install Zsh completion
mycli completion zsh > /usr/local/share/zsh/site-functions/_mycli

# Generate and install Fish completion
mycli completion fish > ~/.config/fish/completions/mycli.fish

Restart your terminal or run source on the config file to apply changes.

Shell completion lets your terminal suggest commands and flags as you type, speeding up your workflow. You generate a small script specific to your shell (Bash, Zsh, or Fish) that teaches it how your CLI works. Once installed, typing your command followed by a space and hitting Tab will show available options.