Skip to content

carapace-sh/carapace-bin

Folders and files

NameName
Last commit message
Last commit date
May 22, 2022
Mar 31, 2023
Apr 8, 2023
Apr 9, 2023
Apr 1, 2023
Apr 9, 2023
Nov 6, 2022
Feb 24, 2023
Mar 18, 2023
Apr 20, 2020
Mar 12, 2023
Feb 24, 2023
Apr 8, 2023
Apr 8, 2023
Oct 17, 2020

Repository files navigation

carapace-bin

PkgGoDev GoReportCard documentation Completers Macros Packaging status

Carapace-bin provides argument completion for multiple CLI commands (full list), and works across multiple POSIX and non-POSIX shells. You can read more about it here: A pragmatic approach to shell completion.

asciicast

Supported shells:

Getting Started

Ensure carapace is added to PATH (Installation). Then register the completers (Setup):

# bash (~/.bashrc)
source <(carapace _carapace)

# elvish (~/.elvish/rc.elv)
eval (carapace _carapace|slurp)

# fish (~/.config/fish/config.fish)
mkdir -p ~/.config/fish/completions
carapace --list | awk '{print $1}' | xargs -I{} touch ~/.config/fish/completions/{}.fish # disable auto-loaded completions (#185)
carapace _carapace | source

# nushell (~/.config/nushell/config.nu)
carapace _carapace nushell # update config.nu manually according to output

# oil (~/.config/oil/oshrc)
source <(carapace _carapace)

# powershell (~/.config/powershell/Microsoft.PowerShell_profile.ps1)
Set-PSReadLineOption -Colors @{ "Selection" = "`e[7m" }
Set-PSReadlineKeyHandler -Key Tab -Function MenuComplete
carapace _carapace | Out-String | Invoke-Expression

# tcsh (~/.tcshrc)
set autolist
eval `carapace _carapace`

# xonsh (~/.config/xonsh/rc.xsh)
COMPLETIONS_CONFIRM=True
exec($(carapace _carapace))

# zsh (~/.zshrc)
source <(carapace _carapace)