Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Groups

Completers are organized into groups.

  • android termux completers
  • bash bash completers
  • bridge bridged completers
  • bsd bsd-like completers
  • cmd cmd completers
  • common common completers
  • darwin macos completers
  • elvish elvish completers
  • fish fish completers
  • linux linux completers
  • unix unix-like completers
  • user user specs
  • system system specs
  • windows windows completers
  • zsh zsh completers

You can list available completers of a group with carapace --list @{group}.

Binaries only contain relevant groups unless built with the build tag force_all.

Shell groups (bash, bash-ble, cmd, elvish, fish, nushell, oil, powershell, tcsh, xonsh, zsh) contain completers for commands and functions of the respective shell. They are experimental and only active if enabled via CARAPACE_BUILTINS. The one matching CARAPACE_SHELL is boosted in priority above the other enabled shell groups.

Priority

Multiple groups providing a completer for a command are ordered by priority.

  • darwin

    1. user
    2. system
    3. shell matching CARAPACE_SHELL
    4. darwin
    5. bsd
    6. unix
    7. common
    8. bridge
    9. other enabled shells
  • linux

    1. user
    2. system
    3. shell matching CARAPACE_SHELL
    4. linux
    5. unix
    6. common
    7. bridge
    8. other enabled shells
  • termux

    1. user
    2. system
    3. shell matching CARAPACE_SHELL
    4. android
    5. linux
    6. unix
    7. common
    8. bridge
    9. other enabled shells
  • windows

    1. user
    2. system
    3. shell matching CARAPACE_SHELL
    4. windows
    5. common
    6. bridge
    7. other enabled shells

You can list available completers of a command with carapace --list {command}.