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

unreleased

Groups

Completers are organized into groups.

  • android termux completers
  • bridge bridged completers
  • bsd bsd-like completers
  • common common completers
  • darwin macos completers
  • linux linux completers
  • unix unix-like completers
  • user user specs
  • system system specs
  • windows windows 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.

Priority

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

  • darwin

    1. user
    2. system
    3. darwin
    4. bsd
    5. unix
    6. common
    7. bridge
  • linux

    1. user
    2. system
    3. linux
    4. unix
    5. common
    6. bridge
  • termux

    1. user
    2. system
    3. android
    4. linux
    5. unix
    6. common
    7. bridge
  • windows

    1. user
    2. system
    3. windows
    4. common
    5. bridge

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