https://github.com/carapace-sh/carapace

A multi-shell completion library.
https://github.com/carapace-sh/carapace

bash carapace cobra completion elvish fish generator ion nushell oil powershell shell tcsh xonsh xontrib zsh

Last synced: 6 days ago
JSON representation

A multi-shell completion library.

• Host: GitHub
• URL: https://github.com/carapace-sh/carapace
• Owner: carapace-sh
• License: apache-2.0
• Created: 2020-03-17T15:25:23.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2025-01-31T13:34:16.000Z (14 days ago)
• Last Synced: 2025-02-01T12:14:48.653Z (13 days ago)
• Topics: bash, carapace, cobra, completion, elvish, fish, generator, ion, nushell, oil, powershell, shell, tcsh, xonsh, xontrib, zsh
• Language: Go
• Homepage: https://carapace.sh
• Size: 14.6 MB
• Stars: 500
• Watchers: 7
• Forks: 11
• Open Issues: 36
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-go - carapace - Command argument completion generator for spf13/cobra. (Command Line / Standard CLI)
• awesome-ccamel - carapace-sh/carapace - A multi-shell completion library. (Go)

README

        
# 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/)

[![GoReportCard](https://goreportcard.com/badge/github.com/carapace-sh/carapace)](https://goreportcard.com/report/github.com/carapace-sh/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/)

- [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://www.oilshell.org/)

- [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