Skip to main content
⏳ Estimated read time: 2 min read

zsh

The stackgen completion zsh command generates an autocompletion script for Zsh shell. This allows you to use the TAB key to complete StackGen commands, flags, and arguments in Zsh.

Usage

stackgen completion zsh [flags]

Flags

FlagDescription
-h, --helpHelp for zsh
--no-descriptionsDisable completion descriptions

Examples

Generate the autocompletion script

stackgen completion zsh > ~/.zsh_completions/_stackgen

This command will:

  • Generate the Zsh completion script
  • Save it to a file in your home directory

Add the completion directory to your .zshrc file

echo "fpath=(~/.zsh_completions $fpath)" >> ~/.zshrc
echo "autoload -U compinit && compinit" >> ~/.zshrc

This command will:

  • Add your completions directory to the fpath array
  • Ensure the completion system is initialized
  • Enable StackGen autocompletion for all new Zsh sessions

Load the completion in your current session

fpath=(~/.zsh_completions $fpath)
autoload -U compinit && compinit

This command will:

  • Update your fpath array to include the completions directory
  • Initialize the completion system
  • Make the StackGen autocompletion available immediately
note
  • Zsh completions are more powerful than Bash completions but require proper setup
  • If you already have completions set up, you might only need to place the file in your completions directory
  • If you update the StackGen CLI, you may need to regenerate the completion script