GitHub Store
carapace-sh

carapace-spec

carapace-sh

A multi-shell completion spec definition tool that generates shell completions for CLI commands via simple spec files, supporting multiple shells.

v1.10.0-alpha
Published at
19d ago
34
Stars
2,367
Download
Synced at
15d ago

Latest release

v1.10.0-alphaSep 30, 2026, 07:34 PM
Downloads slow? Switch the source anytime above

README

Project Overview

carapace-spec defines simple completions using a spec file based on carapace. carapace-bin is recommended for custom macro support.

Key Features

  • Define command completions via YAML spec files
  • Supports flags, persistentflags, and subcommands
  • Positional argument completion (files, lists, directories, etc.)
  • Multiple generator integrations: clap, kingpin, kong, manpages, urfavecli

Target Audience

  • CLI tool developers
  • Users who need shell completions for custom commands

Quick Start

  1. Create a spec file in YAML format
  2. Load the spec with carapace-spec or carapace-bin
  3. Enjoy auto-completion in your shell

Core Advantages

  • Simple and readable spec format
  • Multiple shell support
  • Deep integration with carapace-bin

Release history

Sort