Skip to content

Enabling Autocomplete

Enabling autocomplete on KSDK

Kelvin-SDK features an autocomplete utility for the most standard command line tools in the market. This feature is not available for Windows, only for Linux/MacOS.

It is compatible with terminal shells:

  • bash
  • zsh
  • fish

This utility can be enabled with the following command:

# kelvin configuration autocomplete --shell=<shell-type>
kelvin configuration autocomplete --shell zsh

It will then display the following steps the user must follow:

➜ kelvin configuration autocomplete --help                                                                                                                                                                                                                                 
[kelvin.sdk][2020-06-02 20:06:02][D] Verbose mode enabled.                                                                                                                                                                                                               
Usage: kelvin configuration autocomplete [OPTIONS]                                                                                                                                                                                                                         

  Generate command-completion configuration for KSDK commands.                                                                                                                                                                                                           

  To configure your shell to complete KSDK commands:                                                                                                                                                                                                                     

      Bash:                                                                                                                                                                                                                                                              

          $ kelvin configuration autocomplete --shell bash > ~/.bashrc.ksdk                                                                                                                                                                                                
          $ echo "source ~/.bashrc.ksdk" >> ~/.bashrc                                                                                                                                                                                                                    

      ZSH:                                                                                                                                                                                                                                                               

          $ kelvin configuration autocomplete --shell zsh > ~/.zshrc.ksdk                                                                                                                                                                                                  
          $ echo "source ~/.zshrc.ksdk" >> ~/.zshrc                                                                                                                                                                                                                      

Options:                                                                                                                                                                                                                                                                 
  --shell [bash|zsh|fish]  Name of the shell to generate completion                                                                                                                                                                                                      
                           configuration, e.g. bash, zsh, fish  [required]                                                                                                                                                                                               

  -v, --verbose            Display all executed steps to the screen.                                                                                                                                                                                                     
  --help                   Show this message and exit.