Skip to content

Commit

Permalink
Merge pull request #1021 from carapace-sh/update-readme
Browse files Browse the repository at this point in the history
updated readme
  • Loading branch information
rsteube authored Jun 18, 2024
2 parents d43cac5 + fecd351 commit 16f1d57
Showing 1 changed file with 6 additions and 34 deletions.
40 changes: 6 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@
[![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]. You can read more about it here: _[A pragmatic approach to shell completion](https://dev.to/rsteube/a-pragmatic-approach-to-shell-completion-4gp0)_.

Command argument completion generator for [cobra].

Supported shells:
- [Bash](https://www.gnu.org/software/bash/)
Expand All @@ -20,39 +19,12 @@ Supported shells:
- [Xonsh](https://xon.sh/)
- [Zsh](https://www.zsh.org/)

## Usage

Calling `carapace.Gen` on the root command is sufficient to enable completion using the [hidden command](https://carapace-sh.github.io/carapace/carapace/gen/hiddenSubcommand.html).

```go
import (
"github.com/carapace-sh/carapace"
)

carapace.Gen(rootCmd)
```

## Example

An example implementation can be found in the [example](./example/) folder.


## Standalone Mode

Carapace can also be used to provide completion for arbitrary commands.
See [carapace-bin](https://github.com/carapace-sh/carapace-bin) for examples.
## Getting Started

## Related Projects
[Read], [Try] and [Build].

- [carapace-bin](https://github.com/carapace-sh/carapace-bin) multi-shell multi-command argument completer
- [carapace-bridge](https://github.com/carapace-sh/carapace-bridge) completion bridge
- [carapace-pflag](https://github.com/carapace-sh/carapace-pflag) Drop-in replacement for spf13/pflag with support for non-posix variants
- [carapace-shlex](https://github.com/carapace-sh/carapace-shlex) simple shell lexer
- [carapace-spec](https://github.com/carapace-sh/carapace-spec) define simple completions using a spec file
- [carapace-spec-clap](https://github.com/carapace-sh/carapace-spec-clap) spec generation for clap-rs/clap
- [carapace-spec-kingpin](https://github.com/carapace-sh/carapace-spec-kingpin) spec generation for alecthomas/kingpin
- [carapace-spec-kong](https://github.com/carapace-sh/carapace-spec-kong) spec generation for alecthomas/kong
- [carapace-spec-man](https://github.com/carapace-sh/carapace-spec-man) spec generation for manpages
- [carapace-spec-urfavecli](https://github.com/carapace-sh/carapace-spec-urfavecli) spec generation for urfave/cli
[Read]:https://pixi.carapace.sh
[Try]:./example/
[Build]:https://carapace-sh.github.io/carapace/carapace/gen.html

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

0 comments on commit 16f1d57

Please sign in to comment.