Skip to content
console2svg

completions

Terminal
console2svg completions generate <shell>

completions is a subcommand for generating command-line autocompletion scripts for various shells. It enables quick tab completion for subcommand names, option flags, and argument candidates.

Subcommands and Arguments

Section titled “Subcommands and Arguments”

generate <shell>

Section titled “generate <shell>”

Outputs the completion definition code for the specified shell to standard output. The <shell> argument accepts the following shell names:

  • bash
  • zsh
  • fish
  • pwsh (PowerShell)

Configuration Examples by Shell

Section titled “Configuration Examples by Shell”

Loading the generated script into your shell configuration file enables autocompletion for subsequent shell sessions.

Bash

Section titled “Bash”
Terminal
console2svg completions generate bash > ~/.console2svg.bash
echo "source ~/.console2svg.bash" >> ~/.bashrc

Zsh

Section titled “Zsh”

Place the script in a completion functions directory (fpath):

Terminal
mkdir -p ~/.zsh/completions
console2svg completions generate zsh > ~/.zsh/completions/_console2svg

Add the following to ~/.zshrc (before calling compinit):

Terminal window
fpath=(~/.zsh/completions $fpath)
autoload -Uz compinit && compinit

Fish

Section titled “Fish”
Terminal
console2svg completions generate fish > ~/.config/fish/completions/console2svg.fish

PowerShell

Section titled “PowerShell”
Terminal
console2svg completions generate pwsh >> $PROFILE