Shell Completions

The Shipchart CLI can generate autocompletion scripts for bash, zsh, and fish. Tab-complete commands, subcommands, flags, and dynamic values like project names.

What gets completed

  • Commands and subcommands
  • All flags and their values
  • Project names and IDs
  • Enum values (stages, statuses, moods, etc.)

Zsh

Make sure shell completion is enabled in your environment. If not, add this to your ~/.zshrc:

echo "autoload -U compinit; compinit" >> ~/.zshrc

Current session only

source <(shipchart completion zsh)

Persist across sessions

macOS (Homebrew):

shipchart completion zsh > $(brew --prefix)/share/zsh/site-functions/_shipchart

Linux:

shipchart completion zsh > "${fpath[1]}/_shipchart"

Restart your shell for changes to take effect.

Bash

Requires the bash-completion package. Install it via your package manager if needed.

Current session only

source <(shipchart completion bash)

Persist across sessions

macOS (Homebrew):

shipchart completion bash > $(brew --prefix)/etc/bash_completion.d/shipchart

Linux:

shipchart completion bash > /etc/bash_completion.d/shipchart

Fish

Current session only

shipchart completion fish | source

Persist across sessions

shipchart completion fish > ~/.config/fish/completions/shipchart.fish