Enable CLI command completion

Completion allows you to hit [TAB] on a partially entered akka command and have the shell complete the command, subcommand or flag for you.

bash

To load completion in the current bash shell run:

source <(akka completion)

bash

Configure bash to load akka completions for each session by adding the following line to your ~/.bashrc or ~/.profile file:

# add to ~/.bashrc or ~/.profile
source <(akka completion)

bash

Using bash completions with akka requires you have bash completions enabled to begin with. Enable it in your ~/.bashrc or ~/.profile file with the following lines:

if [ -f /etc/bash_completion ]; then
  source /etc/bash_completion
fi

bash

For definitive details on setting up your shell with auto-completion, see the shell documentation.

zsh (e.g. macOS)

To set up zsh shell completion run:

akka completion zsh > "${fpath[1]}/_akka"
compinit

zsh

If shell completion is not already enabled in your environment execute the following:

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

zsh

fish

To set up fish shell completion run:

akka completion fish > ~/.config/fish/completions/akka.fish
source ~/.config/fish/completions/akka.fish

fish

PowerShell

To set up shell completion for PowerShell run:

akka completion powershell | Out-String | Invoke-Expression

powershell