Skip to content

feat(completion): add nushell and carapace completion generators #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
schoolboyqueue wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(completion): add nushell and carapace completion generators #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 52 additions & 2 deletions docs/public/SHELL-COMPLETION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Shell Completion for autospec

autospec provides built-in shell completion support for `bash`, `zsh`, `fish`, and `powershell` using Cobra's completion system.
autospec provides built-in shell completion support for `bash`, `zsh`, `fish`, and `powershell` using Cobra's completion system. Additionally, `nushell` and many other shells are supported via native generators and `carapace`.

## Features

- **Automatic command completion**: Tab-complete all commands (`full`, `prep`, `specify`, `plan`, `tasks`, `implement`, etc.)
- **Flag completion**: Complete command flags (e.g., `--max-retries`, `--debug`, `--specs-dir`)
- **Stays in sync**: Automatically updates as commands change
- **Multiple shells**: Works with bash, zsh, fish, and powershell
- **Multiple shells**: Works with bash, zsh, fish, powershell, nushell, and many more via carapace
- **One-command installation**: Use `autospec completion install` to automatically configure your shell

## Quick Start (Recommended)
Expand Down Expand Up @@ -165,6 +165,56 @@ autospec completion powershell | Out-String | Invoke-Expression
autospec completion powershell >> $PROFILE
```

## Nushell Setup

Nushell uses native `extern` definitions for completions.

### 1. Generate Completion File

```bash
mkdir -p ~/.cache/autospec
autospec completion nushell | save -f ~/.cache/autospec/completions.nu
```

### 2. Add to config.nu

Add the following to your `~/.config/nushell/config.nu`:

```nushell
source ~/.cache/autospec/completions.nu
```

### 3. Reload Configuration

```nushell
source ~/.config/nushell/config.nu
```

## Carapace (Multi-Shell) Setup

For shells not directly supported (Elvish, Ion, Oil, Tcsh, Xonsh) or for using carapace-bin:

### 1. Generate Spec File

```bash
mkdir -p ~/.config/carapace/specs
autospec completion carapace > ~/.config/carapace/specs/autospec.yaml
```

### 2. Initialize carapace-bin

Follow the [carapace-bin documentation](https://carapace-sh.github.io/carapace-bin/) to set up carapace for your shell.

### Supported Shells via Carapace

- Elvish
- Ion
- Oil
- Tcsh
- Xonsh
- Nushell (alternative to native)
- And more

## Verification

After setup, test completion works:
Expand Down
Loading