# carapace

[![PkgGoDev](https://pkg.go.dev/badge/github.com/carapace-sh/carapace)](https://pkg.go.dev/github.com/carapace-sh/carapace)
[![documentation](https://img.shields.io/badge/‌-documentation-blue?logo=gitbook)](https://carapace-sh.github.io/carapace/)
[![Coverage Status](https://coveralls.io/repos/github/carapace-sh/carapace/badge.svg?branch=master)](https://coveralls.io/github/carapace-sh/carapace?branch=master)

Command argument completion generator for [cobra].

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-sh/issues/331))
- [Xonsh](https://xon.sh/)
- [Zsh](https://www.zsh.org/)

## Getting Started

[Read], [Try] and [Build].

[Read]:https://pixi.carapace.sh
[Try]:./example/
[Build]:https://carapace-sh.github.io/carapace/carapace/gen.html

[cobra]:https://github.com/spf13/cobra