carapace-bin/README.md

# carapace-bin

[![PkgGoDev](https://pkg.go.dev/badge/github.com/carapace-sh/carapace-bin/pkg/actions)](https://pkg.go.dev/github.com/carapace-sh/carapace-bin/pkg/actions)
[![GoReportCard](https://goreportcard.com/badge/github.com/carapace-sh/carapace-bin)](https://goreportcard.com/report/github.com/carapace-sh/carapace-bin)
[![documentation](https://img.shields.io/badge/‌-documentation-blue?logo=gitbook)](https://carapace-sh.github.io/carapace-bin/)
[![Completers](https://carapace-sh.github.io/carapace-bin/badge.svg)](https://carapace-sh.github.io/carapace-bin/completers.html)
[![Macros](https://carapace-sh.github.io/carapace-bin/macros-badge.svg)](https://carapace-sh.github.io/carapace-bin/spec/macros.html)
[![Packaging status](https://repology.org/badge/tiny-repos/carapace.svg)](https://repology.org/project/carapace/versions)
[![faq](https://img.shields.io/badge/discussions-faq-white)](https://github.com/orgs/carapace-sh/discussions?discussions_q=label%3Afaq)

Carapace-bin provides argument completion for multiple CLI commands ([full list](https://carapace-sh.github.io/carapace-bin/completers.html)), and works across multiple POSIX and non-POSIX shells.

![](./docs/src/opengraph-elvish.png)

Supported shells:
- [Bash](https://www.gnu.org/software/bash/)
- [Cmd](https://en.wikipedia.org/wiki/Cmd.exe) ([experimental](https://github.com/carapace-sh/carapace/issues/1107))
- [Elvish](https://elv.sh/)
- [Fish](https://fishshell.com/)
- [Ion](https://doc.redox-os.org/ion-manual/) ([experimental](https://github.com/carapace-sh/carapace/issues/88))
- [Nushell](https://www.nushell.sh/)
- [Oil](http://oils.pub/)
- [Powershell](https://microsoft.com/powershell)
- [Tcsh](https://www.tcsh.org/) ([experimental](https://github.com/carapace-sh/carapace/issues/331))
- [Xonsh](https://xon.sh/)
- [Zsh](https://www.zsh.org/)

## Getting Started

[Read], [Install] and [Setup].

[Read]:https://pixi.carapace.sh
[Install]:https://carapace-sh.github.io/carapace-bin/install.html
[Setup]:https://carapace-sh.github.io/carapace-bin/setup.html