In A Nutshell
Carapace is a shell completion library (carapace-sh/carapace) as well as a binary containing a collection of shell completers (carapace-sh/carapace-bin). It works across multiple operating systems and multiple POSIX and non-POSIX shells.
Getting Started
Refer to Install and Setup to get it up and running on your system.
You can use any shell you want, but it is highly recommended to give Elvish a try. Not only shows it best what Carapace can do. It is pretty awesome anyway.
Links
| Link | Description |
|---|---|
| carapace.sh | website with examples |
| Documentation | |
| carapace-sh.github.io/carapace | documentation of the library |
| carapace-sh.github.io/carapace-bin | documentation of the binary |
| carapace-sh.github.io/carapace-spec | documentation of the spec |
| carapace-sh.github.io/carapace-pixi | picture book introduction |
| Core Projects | |
| carapace | library |
| carapace-bin | binary |
| carapace-bridge | completion bridge for various frameworks |
| carapace-pflag | flag parser for non-posix variants |
| carapace-selfupdate | simple self-update mechanism |
| carapace-shlex | lexer for complex single string arguments |
| carapace-spec | YAML spec for custom completions |
| Scraper | |
| carapace-spec-clap | spec generation for clap-rs/clap |
| carapace-spec-kingpin | spec generation for alecthomas/kingpin |
| carapace-spec-kong | spec generation for alecthomas/kong |
| carapace-spec-man | spec generation for manpages |
| carapace-spec-urfavecli | spec generation for urfave/cli |