Skip to main content

Shell tab completion

Shell tab completion makes it faster to work with Batect. Rather than having to remember CLI options or task names, you can type the start of the name, press Tab, and the name will be filled in for you automatically.

For example, typing ./batect --heTab completes to ./batect --help and typing ./batect buiTab completes to ./batect build.

Batect supports shell tab completion in Bash, Fish and Zsh.

In order to use shell tab completion, you'll need to install the completion script by following the instructions below for your shell.

Bash

If you're using Homebrew, install support for Batect's tab completion with brew install batect/batect/batect-bash-completion.

Otherwise, you'll need to manually install the completion script. Follow the manual installation instructions in the bash-completion repository on GitHub.

Fish

If you're using Homebrew, install support for Batect's tab completion with brew install batect/batect/batect-fish-completion.

Otherwise, you can install support for Batect's tab completion using Fisher with fisher install batect/batect-fish-completion.

Zsh

If you're using Homebrew, install support for Batect's tab completion with brew install batect/batect/batect-zsh-completion.

If you're using Oh My Zsh, follow the instructions in the batect-zsh-completion readme to install support for Batect's tab completion.

Otherwise, you'll need to manually install the completion script, which is available in the zsh-completion repository on GitHub.

Subscribe to the Batect newsletter

Get news and announcements direct to your inbox.