シェルスクリプトにbash補完を追加する設計｜complete・compgenで独自コマンドのタブ補完を実装する方法

この記事のポイント

・complete -W でオプション一覧を登録すれば自作スクリプトがタブ補完できる
・compgen でファイル名・コマンド名・任意リストを動的生成できる
・補完関数（_関数）でサブコマンドごとに候補を切り替えられる
・/etc/bash_completion.d/ に置けば起動時に自動読み込みされる

# complete コマンドの基本構文
complete [オプション] コマンド名

# 現在登録済みの補完定義を一覧確認する
complete -p

# 特定コマンドの補完定義だけ確認する
complete -p git
# 出力例（環境により異なります）
# complete -o bashdefault -o default -o nospace -F __git_wrap__git_main git

# deploy.sh が受け付けるオプション
--production
--staging
--dry-run
--verbose
--help

# ターミナルで直接実行して試す（現在のセッションのみ有効）
complete -W "--production --staging --dry-run --verbose --help" deploy.sh

# 登録後、以下のように入力してタブを押すと候補が表示される
# deploy.sh --[Tab]
# 出力例（環境により異なります）
# --dry-run   --help   --production   --staging   --verbose

# compgen の動作確認（ターミナルで直接実行して試す）

# "b" で始まる単語を候補リストから絞り込む
compgen -W "--backup --build --break" -- "--b"
# 出力例（環境により異なります）
# --backup
# --build

# ファイル名一覧を生成する
compgen -f -- "/"
# 出力例（環境により異なります）
# /bin
# /boot
# /etc  ...

# ディレクトリ名だけを補完させる
complete -A directory restore.sh

#!/usr/bin/env bash
# /etc/bash_completion.d/backup の内容

_backup_sh() {
  local cur prev
  cur="${COMP_WORDS[COMP_CWORD]}"
  prev="${COMP_WORDS[COMP_CWORD-1]}"

  local subcommands="start stop status full-backup incremental-backup"

  case "$prev" in
    backup.sh)
      # サブコマンドの一覧を補完する
      COMPREPLY=( $(compgen -W "$subcommands" -- "$cur") )
      ;;
    full-backup|incremental-backup)
      # バックアップ先のディレクトリを補完する
      COMPREPLY=( $(compgen -d -- "$cur") )
      ;;
    start|stop|status)
      # これらのサブコマンドはオプションなし
      COMPREPLY=()
      ;;
    *)
      COMPREPLY=()
      ;;
  esac
}

complete -F _backup_sh backup.sh

# スクリプトを現在のシェルに読み込む
source /etc/bash_completion.d/backup

# backup.sh の後でタブを押すとサブコマンドが候補に出る
# backup.sh [Tab]
# 出力例（環境により異なります）
# full-backup  incremental-backup  start  status  stop

# full-backup の後でタブを押すとディレクトリ補完になる
# backup.sh full-backup /[Tab]
# 出力例（環境により異なります）
# /boot/  /etc/  /home/  /srv/  /var/

# RHEL 9系の場合
rpm -q bash-completion

# Ubuntu 24.04 LTS の場合
dpkg -l bash-completion

# インストールされていない場合
# RHEL 9系
sudo dnf install bash-completion

# Ubuntu 24.04 LTS
sudo apt install bash-completion

# システム全体（全ユーザーが使えるようにする）
sudo cp backup_completion.sh /etc/bash_completion.d/backup
sudo chmod 644 /etc/bash_completion.d/backup

# 自分のユーザーだけに適用したい場合は ~/.bash_completion を使う
# tee -a で追記する（ファイルが存在しない場合は新規作成される）
echo "source /path/to/backup_completion.sh" | tee -a ~/.bash_completion

# 現在のセッションに反映させる（新規ターミナルを開いてもよい）
source /etc/bash_completion

# 補完が登録されているか確認する
complete -p backup.sh
# 出力例（環境により異なります）
# complete -F _backup_sh backup.sh

# bash_completion の読み込みを確認する
type _completion_loader 2>&1
# 読み込まれている場合の出力例（環境により異なります）
# _completion_loader is a function

# 出力が "bash: type: _completion_loader: not found" の場合は
# ~/.bashrc や /etc/bashrc に以下の記述があるか確認する
grep bash_completion ~/.bashrc /etc/bashrc 2>/dev/null

# 特定スクリプトの補完定義を確認する
complete -p backup.sh 2>&1
# 登録されていない場合の出力例（環境により異なります）
# -bash: complete: backup.sh: no completion specification

# 手動で読み込んでエラーメッセージを確認する
source /etc/bash_completion.d/backup

# bash -n で構文チェックだけ行う（実行しない）
bash -n /etc/bash_completion.d/backup
# エラーがなければ何も出力されない
# エラーがある場合の出力例（環境により異なります）
# /etc/bash_completion.d/backup: line 12: syntax error near unexpected token `fi'