Skip to content

Completion

Generates a completion file for you for a specific shell.

distant generate completion bash

Flags

  • --output <FILE>: indicates that completion file should be saved to a file instead of printed to stdout.

Examples

bash

distant generate completion bash --output ~/.bash_completion.d/distant.sh

elvish

distant generate completion elvish --output ~/.elvish/completions/distant.elv

fish

distant generate completion fish --output ~/.config/fish/completions/distant.fish

powershell

distant generate completion powershell --output $env:USERPROFILE\Documents\WindowsPowerShell\Modules\Distant\distant.ps1

zsh

distant generate completion zsh --output ~/.zsh/completions/_distant
distant generate completion --help
Usage: distant generate completion [OPTIONS] <SHELL>

Arguments:
  <SHELL>  Specific shell to target for the generated output [possible values: bash, elvish, fish, powershell, zsh]

Options:
      --log-level <LOG_LEVEL>  Log level to use throughout the application [possible values: off, error, warn, info, debug, trace]
      --output <FILE>          Write output to a file instead of stdout
      --log-file <LOG_FILE>    Path to file to use for logging
      --config <CONFIG_PATH>   Configuration file to load instead of the default paths
  -h, --help                   Print help