getoptsコマンドでbashスクリプトの引数を処理する方法｜オプション解析と実践例も

この記事のポイント

・getopts は bash 組み込みのオプション解析コマンドで外部コマンド不要
・while getopts "ab:c" opt; do case $opt in で1文字オプションを処理できる
・コロン付き（b:）は引数ありオプション、$OPTARG で値を取得する
・先頭コロン（":ab:"）でサイレントモードにしてエラーを自前処理できる
・shift $((OPTIND - 1)) でオプション処理後の位置引数を詰め直すのが必須
・長いオプション（--verbose）が必要なときは外部コマンド getopt に切り替える

#!/bin/bash
SRC=$1
DST=$2
LOG=$3

rsync -av "$SRC" "$DST" >> "$LOG"

# オプション文字列の例
# "abc"   → -a -b -c を受け取る（引数なし）
# "ab:c"  → -a -b 値 -c を受け取る（b は引数あり）
# ":ab:c" → 先頭のコロンはサイレントモード（エラー処理を自前で行う）

#!/bin/bash

# 基本的な getopts の書き方
while getopts "vn:o:" opt; do
  case $opt in
    v)
      VERBOSE=true
      ;;
    n)
      NAME="$OPTARG"
      ;;
    o)
      OUTPUT="$OPTARG"
      ;;
    \?)
      echo "不明なオプション: -$OPTARG" >&2
      exit 1
      ;;
  esac
done

# オプション以外の残り引数は $@ に残る
shift $((OPTIND - 1))
echo "NAME=$NAME, OUTPUT=$OUTPUT, VERBOSE=$VERBOSE"
echo "残り引数: $@"

#!/bin/bash

# サイレントモード（先頭に : を付ける）
while getopts ":vn:o:" opt; do
  case $opt in
    v) VERBOSE=true ;;
    n) NAME="$OPTARG" ;;
    o) OUTPUT="$OPTARG" ;;
    :)
      # 引数が必要なオプションに引数が与えられなかった場合
      echo "エラー: -$OPTARG には引数が必要です" >&2
      exit 1
      ;;
    \?)
      echo "エラー: 不明なオプション -$OPTARG" >&2
      exit 1
      ;;
  esac
done
shift $((OPTIND - 1))

$ ./myscript.sh -x
エラー: 不明なオプション -x

$ ./myscript.sh -o
エラー: -o には引数が必要です

# 実行権限を付与
$ chmod +x test-opts.sh

# オプションを渡して実行
$ ./test-opts.sh -v -n "webserver01" -o /tmp/result.log

NAME=webserver01, OUTPUT=/tmp/result.log, VERBOSE=true
残り引数:

# 残り引数（ファイル名など）も渡す場合
$ ./test-opts.sh -n "db01" /etc/hosts /etc/hostname

NAME=db01, OUTPUT=, VERBOSE=
残り引数: /etc/hosts /etc/hostname

# -n オプションの引数を省略した場合（通常モード）
$ ./test-opts.sh -n
./test-opts.sh: option requires an argument -- 'n'
不明なオプション: -

#!/bin/bash

usage() {
  cat <&2; usage ;;
    \?) echo "エラー: 不明なオプション -$OPTARG" >&2; usage ;;
  esac
done
shift $((OPTIND - 1))

# 必須オプションのチェック
if [ -z "$NAME" ]; then
  echo "エラー: -n オプション（ホスト名）は必須です" >&2
  usage
fi

echo "ホスト: $NAME, 出力: $OUTPUT, 詳細: ${VERBOSE:-false}"

$ ./myscript.sh -h
使い方: ./myscript.sh [OPTIONS] [ファイル名...]

OPTIONS:
  -v         詳細表示モード
  -n ホスト名  対象ホスト（必須）
  -o 出力先   ログの保存先（デフォルト: /tmp/result.log）
  -h         このヘルプを表示する

$ ./myscript.sh -z
エラー: 不明なオプション -z
使い方: ./myscript.sh [OPTIONS] [ファイル名...]
...

#!/bin/bash
# デフォルト値と環境変数の組み合わせ

# 環境変数で上書き可能なデフォルト値
OUTPUT="${APP_OUTPUT:-/tmp/app.log}"
COUNT="${APP_COUNT:-100}"
TIMEOUT="${APP_TIMEOUT:-30}"

while getopts ":o:n:t:h" opt; do
  case $opt in
    o) OUTPUT="$OPTARG" ;;
    n) COUNT="$OPTARG" ;;
    t) TIMEOUT="$OPTARG" ;;
    h) usage; exit 0 ;;
    :) echo "エラー: -$OPTARG には引数が必要です" >&2; exit 1 ;;
    \?) echo "エラー: 不明なオプション -$OPTARG" >&2; exit 1 ;;
  esac
done
shift $((OPTIND - 1))

echo "OUTPUT : $OUTPUT"
echo "COUNT  : $COUNT"
echo "TIMEOUT: $TIMEOUT"

# デフォルト値で実行
$ bash myscript.sh
OUTPUT : /tmp/app.log
COUNT  : 100
TIMEOUT: 30

# 環境変数で上書き
$ APP_COUNT=500 bash myscript.sh
OUTPUT : /tmp/app.log
COUNT  : 500
TIMEOUT: 30

# オプションで最優先指定（環境変数より優先される）
$ APP_COUNT=500 bash myscript.sh -n 10
OUTPUT : /tmp/app.log
COUNT  : 10
TIMEOUT: 30

#!/bin/bash
# check-hosts.sh: サーバー死活確認スクリプト
# 使い方: ./check-hosts.sh [-v] [-c 回数] [-t タイムアウト秒] ホスト名 [ホスト名...]

COUNT=3
TIMEOUT=5
VERBOSE=false

usage() {
  echo "使い方: $0 [-v] [-c 回数] [-t タイムアウト秒] ホスト名..." >&2
  exit 1
}

while getopts ":vc:t:" opt; do
  case $opt in
    v) VERBOSE=true ;;
    c) COUNT="$OPTARG" ;;
    t) TIMEOUT="$OPTARG" ;;
    :) echo "エラー: -$OPTARG には引数が必要です" >&2; usage ;;
    \?) echo "エラー: 不明なオプション -$OPTARG" >&2; usage ;;
  esac
done

shift $((OPTIND - 1))

# ホスト名がなければエラー
if [ $# -eq 0 ]; then
  echo "エラー: チェック対象のホスト名を指定してください" >&2
  usage
fi

# 各ホストに ping
for host in "$@"; do
  if ping -c "$COUNT" -W "$TIMEOUT" "$host" > /dev/null 2>&1; then
    echo "[OK]   $host は応答しています"
    if "$VERBOSE"; then
      ping -c 1 "$host" | grep "time="
    fi
  else
    echo "[FAIL] $host は応答しません"
  fi
done

# 基本実行
$ ./check-hosts.sh web01.example.local db01.example.local

[OK]   web01.example.local は応答しています
[OK]   db01.example.local は応答しています

# -v オプションで詳細表示
$ ./check-hosts.sh -v -c 1 web01.example.local

[OK]   web01.example.local は応答しています
64 bytes from 192.168.10.11: icmp_seq=1 ttl=64 time=0.312 ms

# 存在しないホスト
$ ./check-hosts.sh -t 2 backup01.example.local

[FAIL] backup01.example.local は応答しません

#!/bin/bash
# disk-report.sh: ディレクトリ使用量レポート
# 使い方: ./disk-report.sh [-d 検索ディレクトリ] [-s しきい値MB] [-v]

TARGET_DIR="/var"
THRESHOLD=500
VERBOSE=false

while getopts ":d:s:v" opt; do
  case $opt in
    d) TARGET_DIR="$OPTARG" ;;
    s) THRESHOLD="$OPTARG" ;;
    v) VERBOSE=true ;;
    :) echo "エラー: -$OPTARG には引数が必要です" >&2; exit 1 ;;
    \?) echo "エラー: 不明なオプション -$OPTARG" >&2; exit 1 ;;
  esac
done

echo "=== ディスク使用量レポート ==="
echo "対象: $TARGET_DIR / しきい値: ${THRESHOLD}MB"
echo ""

# しきい値（MB）を超えるディレクトリを表示
du -mx "$TARGET_DIR" --max-depth=2 2>/dev/null \
  | awk -v threshold="$THRESHOLD" '$1 > threshold {print $0}' \
  | sort -rn \
  | while read size path; do
      echo "[警告] ${size}MB  $path"
    done

if "$VERBOSE"; then
  echo ""
  echo "--- 上位10件（全体） ---"
  du -mx "$TARGET_DIR" --max-depth=2 2>/dev/null | sort -rn | head -10
fi

#!/bin/bash
# log_archive.sh - ログアーカイブの引数設計サンプル
set -eu

SCRIPT=$(basename "$0")

usage() {
  cat <

ログディレクトリ内の古いファイルをアーカイブします。

OPTIONS:
  -o 
   アーカイブ先ディレクトリ（必須）
  -d   何日より古いファイルを対象にするか（デフォルト: 30）
  -v         詳細出力
  -n         ドライラン（実際には移動しない）
  -h         このヘルプを表示する

Example:
  $SCRIPT -o /backup/archive -d 14 -v /var/log/app
EOF
}

ARCHIVE_DIR=""
DAYS=30
VERBOSE=0
DRY_RUN=0

while getopts ":o:d:vnh" opt; do
  case "$opt" in
    o) ARCHIVE_DIR="$OPTARG" ;;
    d) DAYS="$OPTARG" ;;
    v) VERBOSE=1 ;;
    n) DRY_RUN=1 ;;
    h) usage; exit 0 ;;
    :) echo "Error: -$OPTARG には引数が必要です" >&2; usage >&2; exit 1 ;;
    \?) echo "Error: 不明なオプション -$OPTARG" >&2; usage >&2; exit 1 ;;
  esac
done
shift $((OPTIND - 1))

# 必須チェック
[ -z "$ARCHIVE_DIR" ] && { echo "Error: -o は必須です" >&2; usage >&2; exit 1; }
[ $# -lt 1 ]          && { echo "Error: log_dir を指定してください" >&2; usage >&2; exit 1; }

LOG_DIR="$1"

[ ! -d "$LOG_DIR" ] && { echo "Error: $LOG_DIR が見つかりません" >&2; exit 1; }
[ "$DRY_RUN" -eq 0 ] && mkdir -p "$ARCHIVE_DIR"

[ "$VERBOSE" -eq 1 ] && echo "[INFO] ログ対象: $LOG_DIR / 保存先: $ARCHIVE_DIR / 対象: ${DAYS}日以前"

find "$LOG_DIR" -maxdepth 1 -type f -mtime +"$DAYS" | while read -r f; do
  if [ "$DRY_RUN" -eq 1 ]; then
    echo "[DRY-RUN] mv \"$f\" \"$ARCHIVE_DIR/\""
  else
    mv "$f" "$ARCHIVE_DIR/"
    [ "$VERBOSE" -eq 1 ] && echo "[MOVED] $f"
  fi
done
echo "完了"

# ドライランで動作確認（実際には移動しない）
$ bash log_archive.sh -o /backup/archive -d 14 -v -n /var/log/app
[INFO] ログ対象: /var/log/app / 保存先: /backup/archive / 対象: 14日以前
[DRY-RUN] mv "/var/log/app/access-20260724.log" "/backup/archive/"
[DRY-RUN] mv "/var/log/app/error-20260718.log" "/backup/archive/"
完了

# 必須引数なしでエラーと usage を同時に表示
$ bash log_archive.sh /var/log/app
Error: -o は必須です
Usage: log_archive.sh [OPTIONS] 
...

#!/bin/bash
set -euo pipefail

usage() {
  echo "使い方: $0 [--verbose] [--file FILE] [--output DIR] 引数..." >&2
  exit 1
}

# GNU getopt でパース（Linux / bash 環境前提）
OPTS=$(getopt -o vf:o: --long verbose,file:,output: -n "$0" -- "$@") || usage
eval set -- "$OPTS"

VERBOSE=0
INPUT_FILE=""
OUTPUT_DIR="./output"

while true; do
  case "$1" in
    -v | --verbose) VERBOSE=1; shift ;;
    -f | --file)    INPUT_FILE="$2"; shift 2 ;;
    -o | --output)  OUTPUT_DIR="$2"; shift 2 ;;
    --)             shift; break ;;
    *)              echo "不正なオプション: $1" >&2; usage ;;
  esac
done

echo "VERBOSE=$VERBOSE, INPUT_FILE=$INPUT_FILE, OUTPUT_DIR=$OUTPUT_DIR"
echo "残り引数: $*"

$ bash long-opts.sh --verbose --file data.csv --output /tmp /path/to/src
VERBOSE=1, INPUT_FILE=data.csv, OUTPUT_DIR=/tmp
残り引数: /path/to/src

# short option と long option を混在させても動作する
$ bash long-opts.sh -v --output /tmp /path/to/src
VERBOSE=1, INPUT_FILE=, OUTPUT_DIR=/tmp
残り引数: /path/to/src

# OPTIND を確認する
$ cat debug-opts.sh
#!/bin/bash
while getopts "vn:" opt; do
  case $opt in
    v) echo "OPTIND=$OPTIND, opt=$opt" ;;
    n) echo "OPTIND=$OPTIND, opt=$opt, OPTARG=$OPTARG" ;;
  esac
done
echo "shift 前: $@"
shift $((OPTIND - 1))
echo "shift 後: $@"

$ ./debug-opts.sh -v -n server01 file1.txt file2.txt
OPTIND=2, opt=v
OPTIND=4, opt=n, OPTARG=server01
shift 前: -v -n server01 file1.txt file2.txt
shift 後: file1.txt file2.txt

# 関数内で getopts を使う正しい書き方
parse_options() {
  local OPTIND=1  # 必須：関数内でリセット
  local opt

  while getopts "vn:" opt; do
    case $opt in
      v) echo "verbose mode" ;;
      n) echo "name=$OPTARG" ;;
    esac
  done
}

parse_options -v -n test01
parse_options -n server02

# ポート番号のバリデーション例
while getopts ":p:n:" opt; do
  case $opt in
    p)
      if ! echo "$OPTARG" | grep -qE '^[0-9]+$' || [ "$OPTARG" -lt 1 ] || [ "$OPTARG" -gt 65535 ]; then
        echo "エラー: ポート番号は 1～65535 の整数で指定してください" >&2
        exit 1
      fi
      PORT="$OPTARG"
      ;;
    n)
      if ! echo "$OPTARG" | grep -qE '^[0-9]+$'; then
        echo "エラー: -n には正の整数を指定してください" >&2
        exit 1
      fi
      COUNT="$OPTARG"
      ;;
    :) echo "エラー: -$OPTARG には引数が必要です" >&2; exit 1 ;;
    \?) echo "エラー: 不明なオプション -$OPTARG" >&2; exit 1 ;;
  esac
done
echo "指定ポート: $PORT"