[go: up one dir, main page]

Module clap_complete::command

source ·
Available on crate feature unstable-command only.
Expand description

<bin> complete completion integration

To source your completions:

WARNING: We recommend re-sourcing your completions on upgrade. These completions work by generating shell code that calls into your_program while completing. That interface is unstable and a mismatch between the shell code and your_program may result in either invalid completions or no completions being generated. For this reason, we recommend generating the shell code anew on shell startup so that it is “self-correcting” on shell launch, rather than writing the generated completions to a file.

Bash

echo "source <(your_program complete bash)" >> ~/.bashrc

Elvish

echo "eval (your_program complete elvish)" >> ~/.elvish/rc.elv

Fish

echo "source (your_program complete fish | psub)" >> ~/.config/fish/config.fish

Powershell

echo "your_program complete powershell | Invoke-Expression" >> $PROFILE

Zsh

echo "source <(your_program complete zsh)" >> ~/.zshrc

Structs§

  • Bash completion adapter
  • A completion subcommand to add to your CLI
  • Elvish completion adapter
  • Fish completion adapter
  • Powershell completion adapter
  • Zsh completion adapter

Enums§

  • A completion subcommand to add to your CLI
  • Completion support for built-in shells

Traits§