carapace-spec
Define simple completions using a spec file
About carapace-spec
carapace-spec
Define simple completions using a spec file (based on carapace).
The carapace-spec binary can be used to complete spec files, but carapace-bin is recommended as it supports a range of custom macros.
name: mycmd
description: my command
flags:
--optarg?: optarg flag
-r, --repeatable*: repeatable flag
-v=: flag with value
persistentflags:
--help: bool flag
completion:
flag:
optarg: ["one", "two\twith description", "three\twith style\tblue"]
v: ["$files"]
commands:
- name: sub
description: subcommand
completion:
positional:
- ["$list(,)", "1", "2", "3"]
- ["$directories"]
Generators
- 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
- carapace-spec-oclif spec generation for oclif
Frequently Asked Questions
What is carapace-spec?
carapace-spec is a Command Line library for the Go programming language. Define simple completions using a spec file
How do I install carapace-spec?
Install carapace-spec with the Go module system using `go get rsteube/carapace-spec`. Check the repository for the current installation instructions.
What category does carapace-spec belong to?
carapace-spec is listed under Command Line, specifically Standard CLI.