シェルスクリプトにロングオプションを実装する方法｜getoptコマンドで--verbose・--outputを安全に処理する設計

この記事のポイント

・getopts（組み込み）は短形式のみ、getopt（外部コマンド）はロング形式に対応
・GNU getoptは -o と --longopts で短形式・長形式を同時定義できる
・eval set -- "$ARGS" パターンでスペースを含む引数も安全に処理できる
・macOS のBSD getopt は非互換。Linux 専用か GNU getopt 前提で設計する

# getopt のバージョン確認
getopt --version

getopt from util-linux 2.37.4

# RHEL / CentOS Stream / Rocky Linux
sudo dnf install util-linux

# Ubuntu / Debian
sudo apt install util-linux

getopt -o <短形式定義> --long <長形式定義> -n '<スクリプト名>' -- "$@"

ARGS=$(getopt \
  -o vo:c:: \
  --long verbose,output:,config:: \
  -n "$(basename "$0")" \
  -- "$@")

# エラー終了時にメッセージを表示するため、getopt の戻り値を確認する
ARGS=$(getopt -o vo:c:: --long verbose,output:,config:: -n "$(basename "$0")" -- "$@") || {
    echo "Usage: $0 [--verbose] [--output=FILE] [--config[=FILE]] [args...]" >&2
    exit 1
}

# 正規化した引数を $1 $2 ... にセット
eval set -- "$ARGS"

VERBOSE=0
OUTPUT=""
CONFIG=""

while true; do
    case "$1" in
        -v|--verbose)
            VERBOSE=1
            shift
            ;;
        -o|--output)
            OUTPUT="$2"
            shift 2
            ;;
        -c|--config)
            # 任意引数の場合、値があれば $2 に入る
            case "$2" in
                ""|--*)
                    # 値なし: デフォルトを使用
                    CONFIG="/etc/myapp/myapp.conf"
                    shift
                    ;;
                *)
                    CONFIG="$2"
                    shift 2
                    ;;
            esac
            ;;
        --)
            # オプション終端マーカー。以降は通常の引数
            shift
            break
            ;;
        *)
            echo "Internal error: unknown option '$1'" >&2
            exit 1
            ;;
    esac
done

# $@ に残った非オプション引数
REMAINING_ARGS=("$@")

usage() {
    cat <

        -h|--help)
            usage
            exit 0
            ;;

#!/bin/bash
set -euo pipefail

usage() {
    cat <&2
    exit 1
}
eval set -- "$ARGS"

VERBOSE=0
OUTPUT=""

while true; do
    case "$1" in
        -v|--verbose) VERBOSE=1; shift ;;
        -o|--output)  OUTPUT="$2"; shift 2 ;;
        -h|--help)    usage; exit 0 ;;
        --)           shift; break ;;
        *)            echo "Unknown option: $1" >&2; exit 1 ;;
    esac
done

# 必須引数の確認はオプション解析後に行う
if [[ -z "$OUTPUT" ]]; then
    echo "Error: --output は必須です" >&2
    usage >&2
    exit 1
fi

# 正常系: ロングオプションと値
$ bash myapp.sh --verbose --output=/tmp/result.log file1.txt file2.txt
VERBOSE=1, OUTPUT=/tmp/result.log, REMAINING=file1.txt file2.txt

# --output=value 形式でも同じ結果
$ bash myapp.sh -v --output=/tmp/result.log file1.txt
VERBOSE=1, OUTPUT=/tmp/result.log, REMAINING=file1.txt

# 不明なオプション（エラー）
$ bash myapp.sh --invalid
myapp.sh: unrecognized option '--invalid'
Usage: myapp.sh [OPTIONS] [FILE...]
  -v, --verbose     詳細ログ
  -o, --output=FILE 出力先（必須）
  -h, --help        ヘルプ表示

# 必須引数省略（エラー）
$ bash myapp.sh --verbose
Error: --output は必須です

# GNU getopt か BSD getopt かを判定する
if getopt --version 2>&1 | grep -q 'util-linux'; then
    GETOPT_CMD="getopt"
elif command -v ggetopt &>/dev/null; then
    # macOS + Homebrew gnu-getopt
    GETOPT_CMD="ggetopt"
else
    echo "GNU getopt が見つかりません。util-linux または gnu-getopt をインストールしてください。" >&2
    exit 1
fi

#!/bin/bash
# 実行環境: RHEL 9 / Ubuntu 24.04 LTS / GNU getopt (util-linux)
set -euo pipefail

# ---------- ヘルプ ----------
usage() {
    cat <&2; exit 1; }
eval set -- "$ARGS"

# ---------- デフォルト値 ----------
VERBOSE=0
OUTPUT=""
CONFIG="/etc/myapp.conf"
DRY_RUN=0

# ---------- オプション処理 ----------
while true; do
    case "$1" in
        -v|--verbose)
            VERBOSE=1; shift ;;
        -o|--output)
            OUTPUT="$2"; shift 2 ;;
        -c|--config)
            case "$2" in
                ""|--*) shift ;;
                *)      CONFIG="$2"; shift 2 ;;
            esac ;;
        -n|--dry-run)
            DRY_RUN=1; shift ;;
        -h|--help)
            usage; exit 0 ;;
        --)
            shift; break ;;
        *)
            echo "Internal error" >&2; exit 1 ;;
    esac
done

# ---------- 必須チェック ----------
if [[ -z "$OUTPUT" ]]; then
    echo "Error: --output=FILE は必須です" >&2
    usage >&2
    exit 1
fi

# ---------- デバッグ出力 ----------
if (( VERBOSE )); then
    echo "[INFO] verbose モード有効"
    echo "[INFO] output=${OUTPUT}"
    echo "[INFO] config=${CONFIG}"
    echo "[INFO] dry_run=${DRY_RUN}"
    echo "[INFO] remaining args: $*"
fi

# ---------- ここから本処理 ----------
if (( DRY_RUN )); then
    echo "[DRY-RUN] 処理を実行せず終了します"
    exit 0
fi

echo "処理を開始します: output=${OUTPUT}"
# ... 本処理をここに記述 ...