kalix completion

Generate shell completion scripts


The kalix completion command generates completion scripts for Bash, Zsh, fish and PowerShell.

If you are running on Linux or macOS, the command automatically detects your default shell. On Windows, or if you want to generate a completion file for a different shell, you have to provide the flag with the shell type explicitly.

For more help with configuring the completion script, see https://docs.kalix.io/kalix/command-completion.html

To load completions:


$ source <(kalix completion --shell bash)

# To load completions for each session, execute once:
# Linux:
$ kalix completion --shell bash > /etc/bash_completion.d/kalix
# macOS:
$ kalix completion --shell bash > /usr/local/etc/bash_completion.d/kalix


# If shell completion is not already enabled in your environment,
# you will need to enable it.  You can execute the following once:

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

# To load completions for each session, execute once:
$ kalix completion --shell zsh > "${fpath[1]}/_kalix"
# To work around permission issues, you may instead need to execute:
$ kalix completion --shell zsh | sudo tee "${fpath[1]}/_kalix" >/dev/null

# You will need to start a new shell for this setup to take effect.


$ kalix completion --shell fish | source

# To load completions for each session, execute once:
$ kalix completion --shell fish > ~/.config/fish/completions/kalix.fish


PS> kalix completion --shell powershell | Out-String | Invoke-Expression

# To load completions for every new session, run:
# PS> kalix completion --shell powershell > kalix.ps1
# and source this file from your PowerShell profile.
kalix completion [flags]


  -h, --help           help for completion
      --shell string   The shell type for which to generate an auto-completion file. Valid options are 'bash', 'zsh', 'fish' or 'powershell'.
                       (default is the value of the SHELL environment variable if set.)

Options inherited from parent commands

      --config string      location of config file (default "~/.kalix/config.yaml")
      --context string     configuration context to use
      --disable-prompt     Disable all interactive prompts when running kalix commands. If input is required, defaults will be used, or an error will be raised.
                           This is equivalent to setting the environment variable KALIX_DISABLE_PROMPTS to true.
  -o, --output string      set output format to one of [text,json,gotemplate=] (default "text")
  -q, --quiet              set quiet output (helpful when used as part of a script)
      --timeout duration   client command timeout (default 10s)
  -v, --verbose            set verbose output