OS Manuals

/usr/bin/carapace

Multi-shell command-line completion binary providing argument completion for ~1,000 CLI commands

From carapace-bin 1.8.2-r0 (enterprise-packages), captured 2026-11-08 by running carapace --help (exit 0). permalink

A multi-shell completion binary

Usage:
  carapace [flags] [COMPLETER] [bash|elvish|fish|nushell|oil|powershell|tcsh|xonsh|zsh]

Examples:
  All completers and specs:
    bash:       source <(carapace _carapace bash)
    elvish:     eval (carapace _carapace elvish | slurp)
    fish:       carapace _carapace fish | source
    nushell:    carapace _carapace nushell
    oil:        source <(carapace _carapace oil)
    powershell: carapace _carapace powershell | Out-String | Invoke-Expression
    tcsh:       eval `carapace _carapace tcsh`
    xonsh:      exec($(carapace _carapace xonsh))
    zsh:        source <(carapace _carapace zsh)

  Single completer or spec:
    bash:       source <(carapace chmod bash)
    elvish:     eval (carapace chmod elvish | slurp)
    fish:       carapace chmod fish | source
    nushell:    carapace chmod nushell
    oil:        source <(carapace chmod oil)
    powershell: carapace chmod powershell | Out-String | Invoke-Expression
    tcsh:       eval `carapace chmod tcsh`
    xonsh:      exec($(carapace chmod xonsh))
    zsh:        source <(carapace chmod zsh)

  Style:
    set:        carapace --style 'carapace.Value=bold,magenta'
    clear:      carapace --style 'carapace.Description='

  Bridges:
    set-env CARAPACE_BRIDGES 'zsh,fish,bash,inshellisense'

  Shell parameter is optional and if left out carapace will try to detect it by parent process name.
  Some completions are cached at [/tmp/.cache/carapace].
  Config is written to [/tmp/.config/carapace].
  Specs are loaded from [/tmp/.config/carapace/specs].


Flags:
      --choice        list or edit choices
      --clear-cache   clear caches
      --codegen       generate code for spec file
      --condition     list or execute condition
      --detect        detect bridge by invoking command
      --diff          diff completion
      --edit          edit files
  -h, --help          help for carapace
      --list          list completers
      --macro         list or execute macros
      --mcp           run MCP server
      --run           run spec
      --schema        json schema for spec files
      --selfupdate    update to nightly/stable
      --style         set style
  -v, --version       version for carapace
Options (16)
OptionDescriptionSource
--choicelist or edit choiceshelp
--clear-cacheclear cacheshelp
--codegengenerate code for spec filehelp
--conditionlist or execute conditionhelp
--detectdetect bridge by invoking commandhelp
--diffdiff completionhelp
--editedit fileshelp
-h, --helphelp for carapacehelp
--listlist completershelp
--macrolist or execute macroshelp
--mcprun MCP serverhelp
--runrun spechelp
--schemajson schema for spec fileshelp
--selfupdateupdate to nightly/stablehelp
--styleset stylehelp
-v, --versionversion for carapacehelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.