Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

completions

Generate shell completions for tab-completion support.

Usage

adrs completions <SHELL>

Arguments

ArgumentDescription
<SHELL>Shell to generate completions for

Supported Shells

ShellDescription
bashBourne Again Shell
zshZ Shell
fishFish Shell
powershellPowerShell
elvishElvish Shell

Installation

Bash

# Generate completions
adrs completions bash > ~/.bash_completion.d/adrs

# Add to ~/.bashrc
source ~/.bash_completion.d/adrs

Zsh

# Generate completions
adrs completions zsh > ~/.zfunc/_adrs

# Add to ~/.zshrc (before compinit)
fpath=(~/.zfunc $fpath)
autoload -Uz compinit && compinit

Fish

# Generate completions (loaded automatically)
adrs completions fish > ~/.config/fish/completions/adrs.fish

PowerShell

# Generate completions
adrs completions powershell > _adrs.ps1

# Add to your PowerShell profile
. _adrs.ps1

Elvish

# Generate completions
adrs completions elvish > ~/.elvish/lib/adrs.elv

# Add to ~/.elvish/rc.elv
use adrs

Examples

After installation, you can use tab completion:

# Complete commands
adrs <TAB>
init  new  edit  list  search  link  status  ...

# Complete options
adrs new --<TAB>
--format  --variant  --tags  --supersedes  --no-edit  ...

# Complete formats
adrs new --format <TAB>
nygard  madr

Homebrew Users

If you installed via Homebrew, completions may already be configured. Check with:

# Bash (Homebrew)
$(brew --prefix)/etc/bash_completion.d/adrs

# Zsh (Homebrew)
$(brew --prefix)/share/zsh/site-functions/_adrs