Bashでコマンドライン引数を解析するにはどうすればよいですか?


1921

たとえば、次の行で呼び出されるスクリプトがあるとします。

./myscript -vfd ./foo/bar/someFile -o /fizz/someOtherFile

またはこれ:

./myscript -v -f -d -o /fizz/someOtherFile ./foo/bar/someFile 

このようにを解析するのに受け入れられな方法は何ですか、いずれの場合(または2つの組み合わせ)であること$v$fおよび $dすべてに設定されるtrue$outFileと同じになりますか/fizz/someOtherFile


1
zshユーザーの場合は、zparseoptsと呼ばれる組み込みの優れた機能があります。zparseopts -D -E -M -- d=debug -debug=dこれらの両方-dを使用--debugすると、$debug配列のいずれecho $+debug[1]かが使用されている場合、0または1が返されます。参照:zsh.org/mla/users/2011/msg00350.html
dezza

1
本当に良いチュートリアル:linuxcommand.org/lc3_wss0120.php。特に「コマンドラインオプション」の例が好きです。
ガブリエルステープルズ

回答:


2676

方法#1:getopt [s]なしでbashを使用する

キーと値のペアの引数を渡す一般的な方法は次の2つです。

スペースで区切られたbash(例:--option argument)(getopt [s]なし)

使用法 demo-space-separated.sh -e conf -s /etc -l /usr/lib /etc/hosts

cat >/tmp/demo-space-separated.sh <<'EOF'
#!/bin/bash

POSITIONAL=()
while [[ $# -gt 0 ]]
do
key="$1"

case $key in
    -e|--extension)
    EXTENSION="$2"
    shift # past argument
    shift # past value
    ;;
    -s|--searchpath)
    SEARCHPATH="$2"
    shift # past argument
    shift # past value
    ;;
    -l|--lib)
    LIBPATH="$2"
    shift # past argument
    shift # past value
    ;;
    --default)
    DEFAULT=YES
    shift # past argument
    ;;
    *)    # unknown option
    POSITIONAL+=("$1") # save it in an array for later
    shift # past argument
    ;;
esac
done
set -- "${POSITIONAL[@]}" # restore positional parameters

echo "FILE EXTENSION  = ${EXTENSION}"
echo "SEARCH PATH     = ${SEARCHPATH}"
echo "LIBRARY PATH    = ${LIBPATH}"
echo "DEFAULT         = ${DEFAULT}"
echo "Number files in SEARCH PATH with EXTENSION:" $(ls -1 "${SEARCHPATH}"/*."${EXTENSION}" | wc -l)
if [[ -n $1 ]]; then
    echo "Last line of file specified as non-opt/last argument:"
    tail -1 "$1"
fi
EOF

chmod +x /tmp/demo-space-separated.sh

/tmp/demo-space-separated.sh -e conf -s /etc -l /usr/lib /etc/hosts

上記のブロックのコピー貼り付けからの出力:

FILE EXTENSION  = conf
SEARCH PATH     = /etc
LIBRARY PATH    = /usr/lib
DEFAULT         =
Number files in SEARCH PATH with EXTENSION: 14
Last line of file specified as non-opt/last argument:
#93.184.216.34    example.com

Bash Equals-Separated(eg --option=argument)(getopt [s]なし)

使用法 demo-equals-separated.sh -e=conf -s=/etc -l=/usr/lib /etc/hosts

cat >/tmp/demo-equals-separated.sh <<'EOF'
#!/bin/bash

for i in "$@"
do
case $i in
    -e=*|--extension=*)
    EXTENSION="${i#*=}"
    shift # past argument=value
    ;;
    -s=*|--searchpath=*)
    SEARCHPATH="${i#*=}"
    shift # past argument=value
    ;;
    -l=*|--lib=*)
    LIBPATH="${i#*=}"
    shift # past argument=value
    ;;
    --default)
    DEFAULT=YES
    shift # past argument with no value
    ;;
    *)
          # unknown option
    ;;
esac
done
echo "FILE EXTENSION  = ${EXTENSION}"
echo "SEARCH PATH     = ${SEARCHPATH}"
echo "LIBRARY PATH    = ${LIBPATH}"
echo "DEFAULT         = ${DEFAULT}"
echo "Number files in SEARCH PATH with EXTENSION:" $(ls -1 "${SEARCHPATH}"/*."${EXTENSION}" | wc -l)
if [[ -n $1 ]]; then
    echo "Last line of file specified as non-opt/last argument:"
    tail -1 $1
fi
EOF

chmod +x /tmp/demo-equals-separated.sh

/tmp/demo-equals-separated.sh -e=conf -s=/etc -l=/usr/lib /etc/hosts

上記のブロックのコピー貼り付けからの出力:

FILE EXTENSION  = conf
SEARCH PATH     = /etc
LIBRARY PATH    = /usr/lib
DEFAULT         =
Number files in SEARCH PATH with EXTENSION: 14
Last line of file specified as non-opt/last argument:
#93.184.216.34    example.com

このガイド${i#*=}での「部分文字列の削除」の検索について理解を深めるため。これは、が不要なサブプロセスを呼び出すか、2つの不要なサブプロセスを呼び出すことと機能的に同等です。`sed 's/[^=]*=//' <<< "$i"``echo "$i" | sed 's/[^=]*=//'`

方法#2:getopt [s]でbashを使用する

から:http : //mywiki.wooledge.org/BashFAQ/035#getopts

getopt(1)の制限(古い、比較的最近のgetoptバージョン):

  • 空の文字列である引数は処理できません
  • 空白が埋め込まれた引数を処理できません

最近のgetoptバージョンには、これらの制限はありません。

さらに、getoptsこれらの制限がないPOSIXシェル(およびその他)のオファー。単純なgetopts例を含めました。

使用法 demo-getopts.sh -vf /etc/hosts foo bar

cat >/tmp/demo-getopts.sh <<'EOF'
#!/bin/sh

# A POSIX variable
OPTIND=1         # Reset in case getopts has been used previously in the shell.

# Initialize our own variables:
output_file=""
verbose=0

while getopts "h?vf:" opt; do
    case "$opt" in
    h|\?)
        show_help
        exit 0
        ;;
    v)  verbose=1
        ;;
    f)  output_file=$OPTARG
        ;;
    esac
done

shift $((OPTIND-1))

[ "${1:-}" = "--" ] && shift

echo "verbose=$verbose, output_file='$output_file', Leftovers: $@"
EOF

chmod +x /tmp/demo-getopts.sh

/tmp/demo-getopts.sh -vf /etc/hosts foo bar

上記のブロックのコピー貼り付けからの出力:

verbose=1, output_file='/etc/hosts', Leftovers: foo bar

の利点は次のgetoptsとおりです。

  1. 移植性が高く、などの他のシェルでも動作しdashます。
  2. -vf filename典型的なUnixの方法のように、複数の単一オプションを自動的に処理できます。

の欠点getoptsは、追加のコードなし-hでは短いオプション(でなく--help)しか処理できないことです。

すべての構文と変数の意味を説明するgetoptsチュートリアルがあります。bashにはもありhelp getopts、これは参考になるかもしれません。


44
これは本当ですか?Wikipediaによると、新しいGNU拡張バージョンがgetoptあり、のすべての機能が含まれていますgetoptsman getoptUbuntu 13.04ではgetopt - parse command options (enhanced)名前として出力されるため、この拡張バージョンは現在標準であると思います。
Livven 2013

47
何かがあなたのシステムで特定の方法であるということは、「標準である」という仮定の基礎となる非常に弱い前提です。
szablica 2013

13
@Livven、これgetoptはGNUユーティリティではなく、の一部ですutil-linux
Stephane Chazelas 2014

4
を使用する場合は-gt 0、のshift後にを削除し、esacすべてのshiftを1 *) break;;ずつ増やして、このケースを追加します。オプションでない引数を処理できます。例:pastebin.com/6DJ57HTc
Nicolas Lacombe

2
あなたはエコーしません–default。最初の例では、私があればということに気づく–default最後の引数でなければ、それは、(非OPTとみなす)処理されないwhile [[ $# -gt 1 ]]よう設定されている while [[ $# -gt 0 ]]
kolydart

562

拡張されたgetoptについて言及している回答はありません。そして、トップ投票の答えは誤解を招くものです。-⁠vfdスタイルの短いオプション(OPによって要求された)または位置引数の後のオプション(OPによっても要求された)を無視します。そしてそれは構文解析エラーを無視します。代わりに:

  • getoptutil-linuxまたは以前のGNU glibcから拡張されたものを使用します。1
  • getopt_long()GNU glibcのC関数で動作します。
  • 持っているすべての便利な際立った特徴は、(他の人がそれらを持っていません):
    • 引数2でスペース、引用符、さらにはバイナリを処理します(拡張されてgetoptいない場合は処理できません)
    • それが最後にオプションを処理することができますscript.sh -o outFile file1 file2 -vgetoptsこれを実行しません)
    • - =スタイルの長いオプションをscript.sh --outfile=fileOut --infile fileIn許可します:(自己解析の場合、両方を許可すると時間がかかります)
    • 短いオプションを組み合わせることができます(例:-vfd自己解析の場合は実際の作業)
    • 例えば、感動オプションの引数を使用できます-oOutfile-vfdoOutfile
  • すでに3つ古いので、GNUシステムにはこれがありません(たとえば、どのLinuxにも存在します)。
  • 次の方法でその存在をテストできgetopt --testます。→戻り値4。
  • その他getoptまたはシェルビルドティンgetoptsは使用が制限されています。

次の呼び出し

myscript -vfd ./foo/bar/someFile -o /fizz/someOtherFile
myscript -v -f -d -o/fizz/someOtherFile -- ./foo/bar/someFile
myscript --verbose --force --debug ./foo/bar/someFile -o/fizz/someOtherFile
myscript --output=/fizz/someOtherFile ./foo/bar/someFile -vfd
myscript ./foo/bar/someFile -df -v --output /fizz/someOtherFile

すべてのリターン

verbose: y, force: y, debug: y, in: ./foo/bar/someFile, out: /fizz/someOtherFile

次の myscript

#!/bin/bash
# saner programming env: these switches turn some bugs into errors
set -o errexit -o pipefail -o noclobber -o nounset

# -allow a command to fail with !’s side effect on errexit
# -use return value from ${PIPESTATUS[0]}, because ! hosed $?
! getopt --test > /dev/null 
if [[ ${PIPESTATUS[0]} -ne 4 ]]; then
    echo 'I’m sorry, `getopt --test` failed in this environment.'
    exit 1
fi

OPTIONS=dfo:v
LONGOPTS=debug,force,output:,verbose

# -regarding ! and PIPESTATUS see above
# -temporarily store output to be able to check for errors
# -activate quoting/enhanced mode (e.g. by writing out “--options”)
# -pass arguments only via   -- "$@"   to separate them correctly
! PARSED=$(getopt --options=$OPTIONS --longoptions=$LONGOPTS --name "$0" -- "$@")
if [[ ${PIPESTATUS[0]} -ne 0 ]]; then
    # e.g. return value is 1
    #  then getopt has complained about wrong arguments to stdout
    exit 2
fi
# read getopt’s output this way to handle the quoting right:
eval set -- "$PARSED"

d=n f=n v=n outFile=-
# now enjoy the options in order and nicely split until we see --
while true; do
    case "$1" in
        -d|--debug)
            d=y
            shift
            ;;
        -f|--force)
            f=y
            shift
            ;;
        -v|--verbose)
            v=y
            shift
            ;;
        -o|--output)
            outFile="$2"
            shift 2
            ;;
        --)
            shift
            break
            ;;
        *)
            echo "Programming error"
            exit 3
            ;;
    esac
done

# handle non-option arguments
if [[ $# -ne 1 ]]; then
    echo "$0: A single input file is required."
    exit 4
fi

echo "verbose: $v, force: $f, debug: $d, in: $1, out: $outFile"

1つの拡張getoptは、Cygwinを含むほとんどの「bashシステム」で使用できます。OS Xでは、 brew install gnu-getoptまたはsudo port install getopt
2を試してください。POSIXのexec()規則では、コマンドライン引数でバイナリのNULLを渡す信頼できる方法はありません。これらのバイトは、1997年またはそれ以前にリリースされた引数
3の最初のバージョンを途中で終了させます(1997年まで追跡しただけです)。


4
これをありがとう。en.wikipedia.org/wiki/Getoptsの機能表から確認したところ、長いオプションのサポートが必要で、Solarisを使用していない場合getoptは、次の方法に進んでください。
johncip 2017年

4
唯一の注意点getoptは、ラッパースクリプトに固有のオプションがほとんどないラッパースクリプトでは便利に使用できず、ラッパースクリプト以外のオプションをそのままラップされた実行可能ファイルに渡すことです。のは、私が持っていると言うgrepと呼ばれるラッパーをmygrep、私はオプションの持っている--foo固有のをmygrep、私は行うことができない、mygrep --foo -A 2と持っている-A 2に自動的に渡されますgrep。私が必要とやってmygrep --foo -- -A 2これがあなたのソリューションの上に私の実装です。
Kaushal Modi 2017

2
@bobpaul util-linuxに関するあなたの声明も間違っており、誤解を招く可能性があります。Ubuntu/ Debianでは、パッケージは「必須」とマークされています。そのため、常にインストールされます。–どのディストリビューションについて話しているのですか(意図的にインストールする必要があると言います)?
Robert Siemer 2018年

3
これは少なくとも現在の10.14.3までのMacでは機能しないことに注意してください。出荷されるgetoptは、1999年からのBSD getopt ...
jjj

2
@transang戻り値のブール否定。そしてその副作用:コマンドが失敗することを許可します(そうしないと、errexitはエラー時にプログラムを中止します)。-スクリプト内のコメントで詳細がわかります。それ以外の場合:man bash
Robert Siemer

144

より簡潔な方法

script.sh

#!/bin/bash

while [[ "$#" -gt 0 ]]; do
    case $1 in
        -d|--deploy) deploy="$2"; shift ;;
        -u|--uglify) uglify=1 ;;
        *) echo "Unknown parameter passed: $1"; exit 1 ;;
    esac
    shift
done

echo "Should deploy? $deploy"
echo "Should uglify? $uglify"

使用法:

./script.sh -d dev -u

# OR:

./script.sh --deploy dev --uglify

3
これは私がやっていることです。while [[ "$#" > 1 ]]ブールフラグで行を終了することをサポートする場合は、する必要があり./script.sh --debug dev --uglify fast --verboseます。例:gist.github.com/hfossli/4368aa5a577742c3c9f9266ed214aa58
hfossli

12
うわー!シンプルできれい!これは私がこれを使用している方法です:gist.github.com/hfossli/4368aa5a577742c3c9f9266ed214aa58
hfossli

2
これは、ソースを処理したり、機能が実際にどこから始まるのかを人々に考えさせるよりも、各スクリプトに貼り付ける方がはるかに優れています。
RealHandy

警告:これは重複した引数を許容し、最新の引数が優先されます。たとえば./script.sh -d dev -d prod、になりdeploy == 'prod'ます。私はとにかくそれを使用しました:P :):+1:
yair

私はこれを使用しています(ありがとう!)が、空の引数値を許可することに注意してください。たとえば./script.sh -d、エラーを生成せず$deploy、空の文字列に設定するだけです。
EM0

137

from:digitalpeer.comに小さな変更

使用法 myscript.sh -p=my_prefix -s=dirname -l=libname

#!/bin/bash
for i in "$@"
do
case $i in
    -p=*|--prefix=*)
    PREFIX="${i#*=}"

    ;;
    -s=*|--searchpath=*)
    SEARCHPATH="${i#*=}"
    ;;
    -l=*|--lib=*)
    DIR="${i#*=}"
    ;;
    --default)
    DEFAULT=YES
    ;;
    *)
            # unknown option
    ;;
esac
done
echo PREFIX = ${PREFIX}
echo SEARCH PATH = ${SEARCHPATH}
echo DIRS = ${DIR}
echo DEFAULT = ${DEFAULT}

このガイド${i#*=}での「部分文字列の削除」の検索について理解を深めるため。これは、が不要なサブプロセスを呼び出すか、2つの不要なサブプロセスを呼び出すことと機能的に同等です。`sed 's/[^=]*=//' <<< "$i"``echo "$i" | sed 's/[^=]*=//'`


4
きちんと!ただし、これはスペースで区切られた引数àlaに対しては機能しませんmount -t tempfs ...。一つは、おそらくのようなものを経由してこの問題を解決することができますwhile [ $# -ge 1 ]; do param=$1; shift; case $param in; -p) prefix=$1; shift;;など
トビアスKienzler

3
これは-vfdスタイルを組み合わせた短いオプションを処理できません。
Robert Siemer

105

getopt()/ getopts()は良いオプションです。ここから盗まれ

「getopt」の簡単な使用法は、このミニスクリプトに示されています。

#!/bin/bash
echo "Before getopt"
for i
do
  echo $i
done
args=`getopt abc:d $*`
set -- $args
echo "After getopt"
for i
do
  echo "-->$i"
done

私たちが言ったことは、-a、-b、-c、または-dのいずれかが許可されることですが、-cの後に引数が続きます(「c:」はそれを示します)。

これを「g」と呼んで試してみると:

bash-2.05a$ ./g -abc foo
Before getopt
-abc
foo
After getopt
-->-a
-->-b
-->-c
-->foo
-->--

2つの引数から始め、「getopt」はオプションを分解して、それぞれを独自の引数に入れます。「-」も追加されました。


4
の使用$*は壊れていますgetopt。(スペースを含む引数をホースします。)適切な使用法については、私の回答を参照しください。
Robert Siemer

なぜもっと複雑にしたいのですか?
SDsolar 2017

@Matt J、スクリプトの最初の部分(for i)は、$ iの代わりに "$ i"を使用すると、スペースを含む引数を処理できます。getoptsは、スペースを含む引数を処理できないようです。for iループよりもgetoptを使用する利点は何ですか?
thebunnyrules

99

無視する別の例を追加するリスクがあるので、これが私のスキームです。

  • ハンドル-n arg--name=arg
  • 最後に引数を許可します
  • スペルに誤りがある場合は、正しいエラーを表示します
  • 互換性あり、バシズムを使用しない
  • 可読、ループで状態を維持する必要はありません

それが誰かに役立つことを願っています。

while [ "$#" -gt 0 ]; do
  case "$1" in
    -n) name="$2"; shift 2;;
    -p) pidfile="$2"; shift 2;;
    -l) logfile="$2"; shift 2;;

    --name=*) name="${1#*=}"; shift 1;;
    --pidfile=*) pidfile="${1#*=}"; shift 1;;
    --logfile=*) logfile="${1#*=}"; shift 1;;
    --name|--pidfile|--logfile) echo "$1 requires an argument" >&2; exit 1;;

    -*) echo "unknown option: $1" >&2; exit 1;;
    *) handle_argument "$1"; shift 1;;
  esac
done

4
遅れて申し訳ありません。私のスクリプトでは、handle_argument関数がオプション以外のすべての引数を受け取ります。その行を好きなものに置き換える*) die "unrecognized argument: $1"か、引数を変数に収集することができます*) args+="$1"; shift 1;;
ブロンソン2015年

すごい!私はいくつかの答えをテストしましたが、これは多くの位置パラメーター(フラグの前後の両方)を含め、すべてのケースで機能した唯一のものです
ギルヘルムガルニエ

2
簡潔なコードですが、-nを使用し、他の引数を使用しないと、のエラーにより無限ループが発生しshift 2、のshift代わりに2回発行されますshift 2。編集を提案しました。
ラウクサ

42

私はこの質問に約4年遅れていますが、返したいと思います。以前の回答を出発点として使用して、古いアドホックパラメータの解析を整理しました。次に、次のテンプレートコードをリファクタリングしました。=またはスペースで区切られた引数、およびグループ化された複数の短いパラメーターを使用して、長いパラメーターと短いパラメーターの両方を処理します。最後に、param以外の引数を$ 1、$ 2 ..変数に再挿入します。お役に立てれば幸いです。

#!/usr/bin/env bash

# NOTICE: Uncomment if your script depends on bashisms.
#if [ -z "$BASH_VERSION" ]; then bash $0 $@ ; exit $? ; fi

echo "Before"
for i ; do echo - $i ; done


# Code template for parsing command line parameters using only portable shell
# code, while handling both long and short params, handling '-f file' and
# '-f=file' style param data and also capturing non-parameters to be inserted
# back into the shell positional parameters.

while [ -n "$1" ]; do
        # Copy so we can modify it (can't modify $1)
        OPT="$1"
        # Detect argument termination
        if [ x"$OPT" = x"--" ]; then
                shift
                for OPT ; do
                        REMAINS="$REMAINS \"$OPT\""
                done
                break
        fi
        # Parse current opt
        while [ x"$OPT" != x"-" ] ; do
                case "$OPT" in
                        # Handle --flag=value opts like this
                        -c=* | --config=* )
                                CONFIGFILE="${OPT#*=}"
                                shift
                                ;;
                        # and --flag value opts like this
                        -c* | --config )
                                CONFIGFILE="$2"
                                shift
                                ;;
                        -f* | --force )
                                FORCE=true
                                ;;
                        -r* | --retry )
                                RETRY=true
                                ;;
                        # Anything unknown is recorded for later
                        * )
                                REMAINS="$REMAINS \"$OPT\""
                                break
                                ;;
                esac
                # Check for multiple short options
                # NOTICE: be sure to update this pattern to match valid options
                NEXTOPT="${OPT#-[cfr]}" # try removing single short opt
                if [ x"$OPT" != x"$NEXTOPT" ] ; then
                        OPT="-$NEXTOPT"  # multiple short opts, keep going
                else
                        break  # long form, exit inner loop
                fi
        done
        # Done with that param. move to next
        shift
done
# Set the non-parameters back into the positional parameters ($1 $2 ..)
eval set -- $REMAINS


echo -e "After: \n configfile='$CONFIGFILE' \n force='$FORCE' \n retry='$RETRY' \n remains='$REMAINS'"
for i ; do echo - $i ; done

このコードは、次のような引数を持つオプションを処理できません-c1。また、=短いオプションを引数から分離するためにを使用することは珍しい...
Robert Siemer、

2
この便利なコードのチャンクで2つの問題に遭遇しました。2)組み合わせ可能な短いオプションの場合、「[cfr]」パターンに「c」を含めないでください。
2016

36

スクリプトでポータブル解析を作成することは非常にイライラするため、スクリプトの引数解析コードを生成できるFOSSコードジェネレーターであるArgbashに加えて、いくつかの優れた機能を備えています。

https://argbash.io


argbashを書いてくれてありがとう、私はそれを使用したところ、うまく機能することがわかりました。OS X 10.11 El Capitanにある古いbash 3.xをサポートするコードジェネレーターであるため、私は主にargbashを選びました。唯一の欠点は、コードジェネレーターアプローチは、モジュールの呼び出しと比較して、メインスクリプト内のコードがかなり多いことです。
RichVel

実際にArgbashを使用して、スクリプトに含めることも、別のファイルに入れてソースを取得することもできる、自分だけのパースライブラリを作成することができます。それを示すためにを追加し、ドキュメントでもそれをより明示的にしました。
bubla

知ってよかった。その例は興味深いですが、まだ明確ではありません。おそらく、生成されたスクリプトの名前を「parse_lib.sh」などに変更して、メインスクリプトがそれを呼び出す場所を示すことができます(より複雑な使用例であるラッピングスクリプトセクションのように)。
RichVel

この問題は、argbashの最近のバージョンで解決されました。ドキュメントが改善され、クイックスタートargbash-initスクリプトが導入され、argbash.io / generateでオンラインでargbashを
bubla

29

私の回答は主にBruno Bronoskyの回答に基づいていますが、私は彼の2つの純粋なbash実装を、私がかなり頻繁に使用するものにまとめました。

# As long as there is at least one more argument, keep looping
while [[ $# -gt 0 ]]; do
    key="$1"
    case "$key" in
        # This is a flag type option. Will catch either -f or --foo
        -f|--foo)
        FOO=1
        ;;
        # Also a flag type option. Will catch either -b or --bar
        -b|--bar)
        BAR=1
        ;;
        # This is an arg value type option. Will catch -o value or --output-file value
        -o|--output-file)
        shift # past the key and to the value
        OUTPUTFILE="$1"
        ;;
        # This is an arg=value type option. Will catch -o=value or --output-file=value
        -o=*|--output-file=*)
        # No need to shift here since the value is part of the same string
        OUTPUTFILE="${key#*=}"
        ;;
        *)
        # Do whatever you want with extra options
        echo "Unknown option '$key'"
        ;;
    esac
    # Shift after checking all the cases to get the next option
    shift
done

これにより、スペースで区切られたオプション/値と、定義された等しい値の両方を持つことができます。

したがって、次を使用してスクリプトを実行できます。

./myscript --foo -b -o /fizz/file.txt

と同様:

./myscript -f --bar -o=/fizz/file.txt

両方とも同じ最終結果になるはずです。

長所:

  • -arg = valueと-arg valueの両方が可能

  • bashで使用できる任意の引数名で機能します

    • 意味-aまたは-argまたは--argまたは-argまたは何でも
  • 純粋なバッシュ。getoptまたはgetoptsを学習/使用する必要はありません

短所:

  • 引数を結合できません

    • no -abcの意味。-a -b -cを実行する必要があります

これらは私が頭の上で考えることができる唯一の長所/短所です


15

これは使用するのに十分簡単だと思います:

#!/bin/bash
#

readopt='getopts $opts opt;rc=$?;[ $rc$opt == 0? ]&&exit 1;[ $rc == 0 ]||{ shift $[OPTIND-1];false; }'

opts=vfdo:

# Enumerating options
while eval $readopt
do
    echo OPT:$opt ${OPTARG+OPTARG:$OPTARG}
done

# Enumerating arguments
for arg
do
    echo ARG:$arg
done

呼び出し例:

./myscript -v -do /fizz/someOtherFile -f ./foo/bar/someFile
OPT:v 
OPT:d 
OPT:o OPTARG:/fizz/someOtherFile
OPT:f 
ARG:./foo/bar/someFile

1
私はすべてを読みましたが、これは私の好みのものです。-a=1argcスタイルとして使用したくない。私は最初にメインオプション-optionsを置き、後でシングルスペースの特別なオプションを置くことを好みます-o option。私はargvsを読み取るための最も単純な方法とより良い方法を探しています。
m3nda 2015年

これは非常にうまく機能していますが、a:以外のオプションに引数を渡すと、以下のすべてのオプションが引数として使用されます。この行./myscript -v -d fail -o /fizz/someOtherFile -f ./foo/bar/someFileは独自のスクリプトで確認できます。-dオプションがdとして設定されていない:
m3nda '20年

15

@guneysusによる優れた回答を拡張して、ユーザーが好きな構文を使用できるようにする微調整を以下に示します。

command -x=myfilename.ext --another_switch 

command -x myfilename.ext --another_switch

つまり、等号は空白で置き換えることができます。

この「あいまいな解釈」はあなたの好みに合わないかもしれませんが、他のユーティリティと互換性のあるスクリプトを作成している場合(私の場合、ffmpegで動作する必要がある)、柔軟性が役立ちます。

STD_IN=0

prefix=""
key=""
value=""
for keyValue in "$@"
do
  case "${prefix}${keyValue}" in
    -i=*|--input_filename=*)  key="-i";     value="${keyValue#*=}";; 
    -ss=*|--seek_from=*)      key="-ss";    value="${keyValue#*=}";;
    -t=*|--play_seconds=*)    key="-t";     value="${keyValue#*=}";;
    -|--stdin)                key="-";      value=1;;
    *)                                      value=$keyValue;;
  esac
  case $key in
    -i) MOVIE=$(resolveMovie "${value}");  prefix=""; key="";;
    -ss) SEEK_FROM="${value}";          prefix=""; key="";;
    -t)  PLAY_SECONDS="${value}";           prefix=""; key="";;
    -)   STD_IN=${value};                   prefix=""; key="";; 
    *)   prefix="${keyValue}=";;
  esac
done

13

この例ではgetopt、and evalHEREDOCand を使用して、後shiftに続く必須の値の有無にかかわらず、短いパラメーターと長いパラメーターを処理する方法を示します。また、switch / caseステートメントは簡潔でわかりやすいです。

#!/usr/bin/env bash

# usage function
function usage()
{
   cat << HEREDOC

   Usage: $progname [--num NUM] [--time TIME_STR] [--verbose] [--dry-run]

   optional arguments:
     -h, --help           show this help message and exit
     -n, --num NUM        pass in a number
     -t, --time TIME_STR  pass in a time string
     -v, --verbose        increase the verbosity of the bash script
     --dry-run            do a dry run, dont change any files

HEREDOC
}  

# initialize variables
progname=$(basename $0)
verbose=0
dryrun=0
num_str=
time_str=

# use getopt and store the output into $OPTS
# note the use of -o for the short options, --long for the long name options
# and a : for any option that takes a parameter
OPTS=$(getopt -o "hn:t:v" --long "help,num:,time:,verbose,dry-run" -n "$progname" -- "$@")
if [ $? != 0 ] ; then echo "Error in command line arguments." >&2 ; usage; exit 1 ; fi
eval set -- "$OPTS"

while true; do
  # uncomment the next line to see how shift is working
  # echo "\$1:\"$1\" \$2:\"$2\""
  case "$1" in
    -h | --help ) usage; exit; ;;
    -n | --num ) num_str="$2"; shift 2 ;;
    -t | --time ) time_str="$2"; shift 2 ;;
    --dry-run ) dryrun=1; shift ;;
    -v | --verbose ) verbose=$((verbose + 1)); shift ;;
    -- ) shift; break ;;
    * ) break ;;
  esac
done

if (( $verbose > 0 )); then

   # print out all the parameters we read in
   cat <<-EOM
   num=$num_str
   time=$time_str
   verbose=$verbose
   dryrun=$dryrun
EOM
fi

# The rest of your script below

上記のスクリプトの最も重要な行は次のとおりです。

OPTS=$(getopt -o "hn:t:v" --long "help,num:,time:,verbose,dry-run" -n "$progname" -- "$@")
if [ $? != 0 ] ; then echo "Error in command line arguments." >&2 ; exit 1 ; fi
eval set -- "$OPTS"

while true; do
  case "$1" in
    -h | --help ) usage; exit; ;;
    -n | --num ) num_str="$2"; shift 2 ;;
    -t | --time ) time_str="$2"; shift 2 ;;
    --dry-run ) dryrun=1; shift ;;
    -v | --verbose ) verbose=$((verbose + 1)); shift ;;
    -- ) shift; break ;;
    * ) break ;;
  esac
done

短く、要点があり、読みやすく、ほぼすべてを処理します(IMHO)。

それが誰かを助けることを願っています。


1
これは最良の答えの1つです。
ポリワール氏

11

parse_paramsコマンドラインからパラメーターを解析する関数を提供します。

  1. これは純粋なBashソリューションであり、追加のユーティリティはありません。
  2. グローバルスコープを汚染しません。
  3. 簡単に変数を使用できるので、さらにロジックを構築できます。
  4. paramsの前にダッシュの量は問題ではない(--all等しい-all等号をall=all

以下のスクリプトは、コピーと貼り付けのデモです。show_use使用方法を理解するには、関数を参照してくださいparse_params

制限:

  1. スペース区切りのパラメータ(-d 1)をサポートしていません
  2. パラメータ名はダッシュを失うため--any-param-anyparam同等です
  3. eval $(parse_params "$@")bash 関数内で使用する必要があります(グローバルスコープでは機能しません)

#!/bin/bash

# Universal Bash parameter parsing
# Parse equal sign separated params into named local variables
# Standalone named parameter value will equal its param name (--force creates variable $force=="force")
# Parses multi-valued named params into an array (--path=path1 --path=path2 creates ${path[*]} array)
# Puts un-named params as-is into ${ARGV[*]} array
# Additionally puts all named params as-is into ${ARGN[*]} array
# Additionally puts all standalone "option" params as-is into ${ARGO[*]} array
# @author Oleksii Chekulaiev
# @version v1.4.1 (Jul-27-2018)
parse_params ()
{
    local existing_named
    local ARGV=() # un-named params
    local ARGN=() # named params
    local ARGO=() # options (--params)
    echo "local ARGV=(); local ARGN=(); local ARGO=();"
    while [[ "$1" != "" ]]; do
        # Escape asterisk to prevent bash asterisk expansion, and quotes to prevent string breakage
        _escaped=${1/\*/\'\"*\"\'}
        _escaped=${_escaped//\'/\\\'}
        _escaped=${_escaped//\"/\\\"}
        # If equals delimited named parameter
        nonspace="[^[:space:]]"
        if [[ "$1" =~ ^${nonspace}${nonspace}*=..* ]]; then
            # Add to named parameters array
            echo "ARGN+=('$_escaped');"
            # key is part before first =
            local _key=$(echo "$1" | cut -d = -f 1)
            # Just add as non-named when key is empty or contains space
            if [[ "$_key" == "" || "$_key" =~ " " ]]; then
                echo "ARGV+=('$_escaped');"
                shift
                continue
            fi
            # val is everything after key and = (protect from param==value error)
            local _val="${1/$_key=}"
            # remove dashes from key name
            _key=${_key//\-}
            # skip when key is empty
            # search for existing parameter name
            if (echo "$existing_named" | grep "\b$_key\b" >/dev/null); then
                # if name already exists then it's a multi-value named parameter
                # re-declare it as an array if needed
                if ! (declare -p _key 2> /dev/null | grep -q 'declare \-a'); then
                    echo "$_key=(\"\$$_key\");"
                fi
                # append new value
                echo "$_key+=('$_val');"
            else
                # single-value named parameter
                echo "local $_key='$_val';"
                existing_named=" $_key"
            fi
        # If standalone named parameter
        elif [[ "$1" =~ ^\-${nonspace}+ ]]; then
            # remove dashes
            local _key=${1//\-}
            # Just add as non-named when key is empty or contains space
            if [[ "$_key" == "" || "$_key" =~ " " ]]; then
                echo "ARGV+=('$_escaped');"
                shift
                continue
            fi
            # Add to options array
            echo "ARGO+=('$_escaped');"
            echo "local $_key=\"$_key\";"
        # non-named parameter
        else
            # Escape asterisk to prevent bash asterisk expansion
            _escaped=${1/\*/\'\"*\"\'}
            echo "ARGV+=('$_escaped');"
        fi
        shift
    done
}

#--------------------------- DEMO OF THE USAGE -------------------------------

show_use ()
{
    eval $(parse_params "$@")
    # --
    echo "${ARGV[0]}" # print first unnamed param
    echo "${ARGV[1]}" # print second unnamed param
    echo "${ARGN[0]}" # print first named param
    echo "${ARG0[0]}" # print first option param (--force)
    echo "$anyparam"  # print --anyparam value
    echo "$k"         # print k=5 value
    echo "${multivalue[0]}" # print first value of multi-value
    echo "${multivalue[1]}" # print second value of multi-value
    [[ "$force" == "force" ]] && echo "\$force is set so let the force be with you"
}

show_use "param 1" --anyparam="my value" param2 k=5 --force --multi-value=test1 --multi-value=test2

デモを使用してbashスクリプトにshow_use "$@"
含まれるパラメーター

基本的に私はgithub.com/renatosilva/easyoptionsが同じ方法で同じことを行うが、この関数より少し重いことを発見しました。
Oleksii Chekulaiev 2016

10

EasyOptionsは解析を必要としません。

## Options:
##   --verbose, -v  Verbose mode
##   --output=FILE  Output filename

source easyoptions || exit

if test -n "${verbose}"; then
    echo "output file is ${output}"
    echo "${arguments[@]}"
fi

サンプルスクリプトの上部にあるコメントが解析されて、デフォルトの使用法ヘルプ文字列と引数の指定が提供されていることを理解するのに1分かかりました。これは素晴らしい解決策であり、2年間で6票しか得られなかったことを残念に思います。おそらく、この質問は、人々が気づくには多すぎます。
Metamorphic

ある意味では、あなたのソリューションは断然最高です(@OleksiiChekulaievの「標準」オプション構文をサポートしていないことを除いて)。これは、ソリューションでは、スクリプト作成者が各オプションの名前を一度だけ指定する必要があるためです。他のソリューションでは3回指定する必要があるという事実-使用法、「ケース」パターン、および変数の設定で-絶えず私を悩ませてきました。getoptにもこの問題があります。ただし、私のマシンではコードが遅い-Bash実装では0.11秒、Rubyでは0.28秒。明示的な「while-case」解析の0.02秒との比較。
Metamorphic

おそらくCで書かれたより高速なバージョンが必要です。また、zshと互換性のあるバージョンも必要です。これは別の質問に値するかもしれません(「標準の長いオプションの構文を受け入れ、オプション名を複数回入力する必要がない、Bashのようなシェルでコマンドライン引数を解析する方法はありますか?」)。
Metamorphic

10

getoptsは、#1をインストールし、#2を同じプラットフォームで実行する場合に機能します。OSXとLinux(たとえば)は、この点で動作が異なります。

これは、等しい、等しくない、ブールフラグをサポートする(非getopts)ソリューションです。たとえば、次のようにスクリプトを実行できます。

./script --arg1=value1 --arg2 value2 --shouldClean

# parse the arguments.
COUNTER=0
ARGS=("$@")
while [ $COUNTER -lt $# ]
do
    arg=${ARGS[$COUNTER]}
    let COUNTER=COUNTER+1
    nextArg=${ARGS[$COUNTER]}

    if [[ $skipNext -eq 1 ]]; then
        echo "Skipping"
        skipNext=0
        continue
    fi

    argKey=""
    argVal=""
    if [[ "$arg" =~ ^\- ]]; then
        # if the format is: -key=value
        if [[ "$arg" =~ \= ]]; then
            argVal=$(echo "$arg" | cut -d'=' -f2)
            argKey=$(echo "$arg" | cut -d'=' -f1)
            skipNext=0

        # if the format is: -key value
        elif [[ ! "$nextArg" =~ ^\- ]]; then
            argKey="$arg"
            argVal="$nextArg"
            skipNext=1

        # if the format is: -key (a boolean flag)
        elif [[ "$nextArg" =~ ^\- ]] || [[ -z "$nextArg" ]]; then
            argKey="$arg"
            argVal=""
            skipNext=0
        fi
    # if the format has not flag, just a value.
    else
        argKey=""
        argVal="$arg"
        skipNext=0
    fi

    case "$argKey" in 
        --source-scmurl)
            SOURCE_URL="$argVal"
        ;;
        --dest-scmurl)
            DEST_URL="$argVal"
        ;;
        --version-num)
            VERSION_NUM="$argVal"
        ;;
        -c|--clean)
            CLEAN_BEFORE_START="1"
        ;;
        -h|--help|-help|--h)
            showUsage
            exit
        ;;
    esac
done

8

これは、スタック内のより高い場所で同時に実行されるgetoptsを壊さないようにするための関数での方法です。

function waitForWeb () {
   local OPTIND=1 OPTARG OPTION
   local host=localhost port=8080 proto=http
   while getopts "h:p:r:" OPTION; do
      case "$OPTION" in
      h)
         host="$OPTARG"
         ;;
      p)
         port="$OPTARG"
         ;;
      r)
         proto="$OPTARG"
         ;;
      esac
   done
...
}

8

@ bruno-bronoskyの答えを拡張して、いくつかの一般的なフォーマットを処理する「プリプロセッサー」を追加しました。

  • 拡大--longopt=val--longopt val
  • 拡大-xyz-x -y -z
  • --フラグの終わりを示すためのサポート
  • 予期しないオプションのエラーを表示します
  • コンパクトで読みやすいオプションスイッチ
#!/bin/bash

# Report usage
usage() {
  echo "Usage:"
  echo "$(basename $0) [options] [--] [file1, ...]"

  # Optionally exit with a status code
  if [ -n "$1" ]; then
    exit "$1"
  fi
}

invalid() {
  echo "ERROR: Unrecognized argument: $1" >&2
  usage 1
}

# Pre-process options to:
# - expand -xyz into -x -y -z
# - expand --longopt=arg into --longopt arg
ARGV=()
END_OF_OPT=
while [[ $# -gt 0 ]]; do
  arg="$1"; shift
  case "${END_OF_OPT}${arg}" in
    --) ARGV+=("$arg"); END_OF_OPT=1 ;;
    --*=*)ARGV+=("${arg%%=*}" "${arg#*=}") ;;
    --*) ARGV+=("$arg"); END_OF_OPT=1 ;;
    -*) for i in $(seq 2 ${#arg}); do ARGV+=("-${arg:i-1:1}"); done ;;
    *) ARGV+=("$arg") ;;
  esac
done

# Apply pre-processed options
set -- "${ARGV[@]}"

# Parse options
END_OF_OPT=
POSITIONAL=()
while [[ $# -gt 0 ]]; do
  case "${END_OF_OPT}${1}" in
    -h|--help)      usage 0 ;;
    -p|--password)  shift; PASSWORD="$1" ;;
    -u|--username)  shift; USERNAME="$1" ;;
    -n|--name)      shift; names+=("$1") ;;
    -q|--quiet)     QUIET=1 ;;
    -C|--copy)      COPY=1 ;;
    -N|--notify)    NOTIFY=1 ;;
    --stdin)        READ_STDIN=1 ;;
    --)             END_OF_OPT=1 ;;
    -*)             invalid "$1" ;;
    *)              POSITIONAL+=("$1") ;;
  esac
  shift
done

# Restore positional parameters
set -- "${POSITIONAL[@]}"

6

cmdline引数を解析する方法はいくつかあります(例:GNU getopt(移植不可)とBSD(OSX)getoptとgetopts)-すべて問題があります。このソリューションは

  • ポータブル!
  • 依存関係はなく、bashビルトインにのみ依存しています
  • 短いオプションと長いオプションの両方が可能
  • オプションと引数の間の空白を処理しますが、=セパレータも使用できます
  • 連結された短いオプションスタイルをサポート -vxf
  • オプションの引数を持つオプションを処理します(例を参照)。
  • 同じ機能セットの代替と比較して、コードの膨張を必要としません。つまり、簡潔であるため、保守が容易です。

例:次のいずれか

# flag
-f
--foo

# option with required argument
-b"Hello World"
-b "Hello World"
--bar "Hello World"
--bar="Hello World"

# option with optional argument
--baz
--baz="Optional Hello"

#!/usr/bin/env bash

usage() {
  cat - >&2 <<EOF
NAME
    program-name.sh - Brief description

SYNOPSIS
    program-name.sh [-h|--help]
    program-name.sh [-f|--foo]
                    [-b|--bar <arg>]
                    [--baz[=<arg>]]
                    [--]
                    FILE ...

REQUIRED ARGUMENTS
  FILE ...
          input files

OPTIONS
  -h, --help
          Prints this and exits

  -f, --foo
          A flag option

  -b, --bar <arg>
          Option requiring an argument <arg>

  --baz[=<arg>]
          Option that has an optional argument <arg>. If <arg>
          is not specified, defaults to 'DEFAULT'
  --     
          Specify end of options; useful if the first non option
          argument starts with a hyphen

EOF
}

fatal() {
    for i; do
        echo -e "${i}" >&2
    done
    exit 1
}

# For long option processing
next_arg() {
    if [[ $OPTARG == *=* ]]; then
        # for cases like '--opt=arg'
        OPTARG="${OPTARG#*=}"
    else
        # for cases like '--opt arg'
        OPTARG="${args[$OPTIND]}"
        OPTIND=$((OPTIND + 1))
    fi
}

# ':' means preceding option character expects one argument, except
# first ':' which make getopts run in silent mode. We handle errors with
# wildcard case catch. Long options are considered as the '-' character
optspec=":hfb:-:"
args=("" "$@")  # dummy first element so $1 and $args[1] are aligned
while getopts "$optspec" optchar; do
    case "$optchar" in
        h) usage; exit 0 ;;
        f) foo=1 ;;
        b) bar="$OPTARG" ;;
        -) # long option processing
            case "$OPTARG" in
                help)
                    usage; exit 0 ;;
                foo)
                    foo=1 ;;
                bar|bar=*) next_arg
                    bar="$OPTARG" ;;
                baz)
                    baz=DEFAULT ;;
                baz=*) next_arg
                    baz="$OPTARG" ;;
                -) break ;;
                *) fatal "Unknown option '--${OPTARG}'" "see '${0} --help' for usage" ;;
            esac
            ;;
        *) fatal "Unknown option: '-${OPTARG}'" "See '${0} --help' for usage" ;;
    esac
done

shift $((OPTIND-1))

if [ "$#" -eq 0 ]; then
    fatal "Expected at least one required argument FILE" \
    "See '${0} --help' for usage"
fi

echo "foo=$foo, bar=$bar, baz=$baz, files=${@}"

5

私のバージョンのオプション解析を提供したいと思います。これにより、次のことが可能になります。

-s p1
--stage p1
-w somefolder
--workfolder somefolder
-sw p1 somefolder
-e=hello

これも可能にします(望ましくない可能性があります):

-s--workfolder p1 somefolder
-se=hello p1
-swe=hello p1 somefolder

=をオプションで使用するかどうかを使用前に決定する必要があります。これはコードをクリーンに保つためです。

while [[ $# > 0 ]]
do
    key="$1"
    while [[ ${key+x} ]]
    do
        case $key in
            -s*|--stage)
                STAGE="$2"
                shift # option has parameter
                ;;
            -w*|--workfolder)
                workfolder="$2"
                shift # option has parameter
                ;;
            -e=*)
                EXAMPLE="${key#*=}"
                break # option has been fully handled
                ;;
            *)
                # unknown option
                echo Unknown option: $key #1>&2
                exit 10 # either this: my preferred way to handle unknown options
                break # or this: do this to signal the option has been handled (if exit isn't used)
                ;;
        esac
        # prepare for next option in this key, if any
        [[ "$key" = -? || "$key" == --* ]] && unset key || key="${key/#-?/-}"
    done
    shift # option(s) fully processed, proceed to next input argument
done

1
$ {key + x}の「+ x」の意味は何ですか?
Luca Davanzo 2016年

1
「キー」が存在するかどうかを確認するためのテストです。さらに下を押すと、キーの設定が解除され、これにより内部のwhileループが壊れます。
galmok 2016年

5

未処理の引数を保持するソリューション。デモが含まれています。

これが私の解決策です。非常に柔軟性があり、他とは異なり、外部パッケージを必要とせず、残った引数をきれいに処理します。

使い方は: ./myscript -flag flagvariable -otherflag flagvar2

必要なことは、validflags行を編集することだけです。ハイフンを付加し、すべての引数を検索します。次に、次の引数をフラグ名として定義します。

./myscript -flag flagvariable -otherflag flagvar2
echo $flag $otherflag
flagvariable flagvar2

メインコード(短いバージョン、例のある詳細、さらにエラーのあるバージョン):

#!/usr/bin/env bash
#shebang.io
validflags="rate time number"
count=1
for arg in $@
do
    match=0
    argval=$1
    for flag in $validflags
    do
        sflag="-"$flag
        if [ "$argval" == "$sflag" ]
        then
            declare $flag=$2
            match=1
        fi
    done
        if [ "$match" == "1" ]
    then
        shift 2
    else
        leftovers=$(echo $leftovers $argval)
        shift
    fi
    count=$(($count+1))
done
#Cleanup then restore the leftovers
shift $#
set -- $leftovers

エコーデモが組み込まれた詳細バージョン:

#!/usr/bin/env bash
#shebang.io
rate=30
time=30
number=30
echo "all args
$@"
validflags="rate time number"
count=1
for arg in $@
do
    match=0
    argval=$1
#   argval=$(echo $@ | cut -d ' ' -f$count)
    for flag in $validflags
    do
            sflag="-"$flag
        if [ "$argval" == "$sflag" ]
        then
            declare $flag=$2
            match=1
        fi
    done
        if [ "$match" == "1" ]
    then
        shift 2
    else
        leftovers=$(echo $leftovers $argval)
        shift
    fi
    count=$(($count+1))
done

#Cleanup then restore the leftovers
echo "pre final clear args:
$@"
shift $#
echo "post final clear args:
$@"
set -- $leftovers
echo "all post set args:
$@"
echo arg1: $1 arg2: $2

echo leftovers: $leftovers
echo rate $rate time $time number $number

最後に、これは無効な引数が渡された場合にエラーになります。

#!/usr/bin/env bash
#shebang.io
rate=30
time=30
number=30
validflags="rate time number"
count=1
for arg in $@
do
    argval=$1
    match=0
        if [ "${argval:0:1}" == "-" ]
    then
        for flag in $validflags
        do
                sflag="-"$flag
            if [ "$argval" == "$sflag" ]
            then
                declare $flag=$2
                match=1
            fi
        done
        if [ "$match" == "0" ]
        then
            echo "Bad argument: $argval"
            exit 1
        fi
        shift 2
    else
        leftovers=$(echo $leftovers $argval)
        shift
    fi
    count=$(($count+1))
done
#Cleanup then restore the leftovers
shift $#
set -- $leftovers
echo rate $rate time $time number $number
echo leftovers: $leftovers

長所:それが何をするか、それは非常にうまく処理します。これは、他の多くのソリューションが保持していない未使用の引数を保持します。また、スクリプトで手動で定義しなくても、変数を呼び出すことができます。また、対応する引数が指定されていない場合、変数の事前入力も可能です。(詳細な例を参照)。

短所:単一の複雑な引数文字列を解析できません。たとえば、-xcvfは単一の引数として処理されます。ただし、この機能を追加する追加のコードをいくらか簡単に作成することもできます。



3

これgetopt(1)はAT&Tの短命の過ちだったことに注意してください。

getoptは1984年に作成されましたが、実際には使用できなかったため、1986年にすでに埋葬されています。

getopt非常に古くなっているという事実の証拠は、getopt(1)manページがの"$*"代わりにまだ言及していることです"$@"。これは、getopts(1)内部のスペースを持つ引数を処理するために、組み込みシェルとともに1986年にBourne Shellに追加されました。

ところで、シェルスクリプトで長いオプションを解析することに興味がある場合はgetopt(3)、libc(Solaris)のksh93実装と、長いオプションをサポートする統一された長いオプションの実装を短いオプションのエイリアスとして追加したことを知っておくとよいでしょう。これによりksh93、およびにより、Bourne Shellを介しgetoptsた長いオプション用の統一されたインターフェイスが実装されます。

Bourne Shellのmanページから取った長いオプションの例:

getopts "f:(file)(input-file)o:(output-file)" OPTX "$@"

は、オプションエイリアスをBourne Shellとksh93の両方で使用できる期間を示しています。

最近のBourne Shellのmanページを見てください:

http://schillix.sourceforge.net/man/man1/bosh.1.html

OpenSolarisのgetopt(3)のmanページ:

http://schillix.sourceforge.net/man/man3c/getopt.3c.html

そして最後に、古い$ *を確認するためのgetopt(1)のmanページ:

http://schillix.sourceforge.net/man/man1/getopt.1.html


3

私はbashヘルパーを書いて素敵なbashツールを書いています

プロジェクトのホーム:https : //gitlab.mbedsys.org/mbedsys/bashopts

例:

#!/bin/bash -ei

# load the library
. bashopts.sh

# Enable backtrace dusplay on error
trap 'bashopts_exit_handle' ERR

# Initialize the library
bashopts_setup -n "$0" -d "This is myapp tool description displayed on help message" -s "$HOME/.config/myapprc"

# Declare the options
bashopts_declare -n first_name -l first -o f -d "First name" -t string -i -s -r
bashopts_declare -n last_name -l last -o l -d "Last name" -t string -i -s -r
bashopts_declare -n display_name -l display-name -t string -d "Display name" -e "\$first_name \$last_name"
bashopts_declare -n age -l number -d "Age" -t number
bashopts_declare -n email_list -t string -m add -l email -d "Email adress"

# Parse arguments
bashopts_parse_args "$@"

# Process argument
bashopts_process_args

助けになります:

NAME:
    ./example.sh - This is myapp tool description displayed on help message

USAGE:
    [options and commands] [-- [extra args]]

OPTIONS:
    -h,--help                          Display this help
    -n,--non-interactive true          Non interactive mode - [$bashopts_non_interactive] (type:boolean, default:false)
    -f,--first "John"                  First name - [$first_name] (type:string, default:"")
    -l,--last "Smith"                  Last name - [$last_name] (type:string, default:"")
    --display-name "John Smith"        Display name - [$display_name] (type:string, default:"$first_name $last_name")
    --number 0                         Age - [$age] (type:number, default:0)
    --email                            Email adress - [$email_list] (type:string, default:"")

楽しい :)


Mac OS Xでこれを取得します: `` `lib / bashopts.sh:138行目:declare:-A:無効なオプションdeclare:使用法:declare [-afFirtx] [-p] [name [= value] ...] lib / bashopts.sh:138のエラー。'declare -x -A bashopts_optprop_name' exited with status 2 Call tr​​ee:1:lib / controller.sh:4 source(...)Exiting with status 1 `` `
Josh Wulf

これを使用するには、Bashバージョン4が必要です。Macでは、デフォルトのバージョンは、あなたがbashの4をインストールするには自家製を使用することができます3です
ジョシュ・ウルフ

3

これが私のアプローチです-正規表現を使用します。

  • getoptsなし
  • 短いパラメータのブロックを処理します -qwerty
  • 短いパラメータを処理します -q -w -e
  • 長いオプションを扱います --qwerty
  • 属性を短いオプションまたは長いオプションに渡すことができます(短いオプションのブロックを使用している場合、属性は最後のオプションにアタッチされます)
  • あなたは、スペースを使用することができますか=ハイフン+スペース「区切り文字を」遭遇するまでの属性が、属性の一致を提供するために、これで--q=qwe ty qwe ty一つの属性であります
  • 上記すべてのミックスを処理するため-o a -op attr ibute --option=att ribu te --op-tion attribute --option att-ribute、有効です

脚本:

#!/usr/bin/env sh

help_menu() {
  echo "Usage:

  ${0##*/} [-h][-l FILENAME][-d]

Options:

  -h, --help
    display this help and exit

  -l, --logfile=FILENAME
    filename

  -d, --debug
    enable debug
  "
}

parse_options() {
  case $opt in
    h|help)
      help_menu
      exit
     ;;
    l|logfile)
      logfile=${attr}
      ;;
    d|debug)
      debug=true
      ;;
    *)
      echo "Unknown option: ${opt}\nRun ${0##*/} -h for help.">&2
      exit 1
  esac
}
options=$@

until [ "$options" = "" ]; do
  if [[ $options =~ (^ *(--([a-zA-Z0-9-]+)|-([a-zA-Z0-9-]+))(( |=)(([\_\.\?\/\\a-zA-Z0-9]?[ -]?[\_\.\?a-zA-Z0-9]+)+))?(.*)|(.+)) ]]; then
    if [[ ${BASH_REMATCH[3]} ]]; then # for --option[=][attribute] or --option[=][attribute]
      opt=${BASH_REMATCH[3]}
      attr=${BASH_REMATCH[7]}
      options=${BASH_REMATCH[9]}
    elif [[ ${BASH_REMATCH[4]} ]]; then # for block options -qwert[=][attribute] or single short option -a[=][attribute]
      pile=${BASH_REMATCH[4]}
      while (( ${#pile} > 1 )); do
        opt=${pile:0:1}
        attr=""
        pile=${pile/${pile:0:1}/}
        parse_options
      done
      opt=$pile
      attr=${BASH_REMATCH[7]}
      options=${BASH_REMATCH[9]}
    else # leftovers that don't match
      opt=${BASH_REMATCH[10]}
      options=""
    fi
    parse_options
  fi
done

このように。多分ちょうど-e paramを追加して新しい行でエコーします。
mauron85 2017年

3

test_args.sh次の名前のシェルスクリプトを作成するとします。

#!/bin/sh
until [ $# -eq 0 ]
do
  name=${1:1}; shift;
  if [[ -z "$1" || $1 == -* ]] ; then eval "export $name=true"; else eval "export $name=$1"; shift; fi  
done
echo "year=$year month=$month day=$day flag=$flag"

次のコマンドを実行した後:

sh test_args.sh  -year 2017 -flag  -month 12 -day 22 

出力は次のようになります。

year=2017 month=12 day=22 flag=true

5
これは、ノアの回答と同じアプローチをとりますが、安全性チェック/保護手段が少なくなっています。これにより、スクリプトの環境に任意の引数を書き込むことができます。ここでevalを使用すると、コマンドインジェクションが可能になると確信しています。
バーンウェルは

2

bash-modulesのモジュール「引数」を使用する

例:

#!/bin/bash
. import.sh log arguments

NAME="world"

parse_arguments "-n|--name)NAME;S" -- "$@" || {
  error "Cannot parse command line."
  exit 1
}

info "Hello, $NAME!"

2

位置引数とフラグベースの引数の混在

--param = arg(区切り文字と等しい)

位置引数間でフラグを自由に混ぜる:

./script.sh dumbo 127.0.0.1 --environment=production -q -d
./script.sh dumbo --environment=production 127.0.0.1 --quiet -d

かなり簡潔なアプローチで達成できます:

# process flags
pointer=1
while [[ $pointer -le $# ]]; do
   param=${!pointer}
   if [[ $param != "-"* ]]; then ((pointer++)) # not a parameter flag so advance pointer
   else
      case $param in
         # paramter-flags with arguments
         -e=*|--environment=*) environment="${param#*=}";;
                  --another=*) another="${param#*=}";;

         # binary flags
         -q|--quiet) quiet=true;;
                 -d) debug=true;;
      esac

      # splice out pointer frame from positional list
      [[ $pointer -gt 1 ]] \
         && set -- ${@:1:((pointer - 1))} ${@:((pointer + 1)):$#} \
         || set -- ${@:((pointer + 1)):$#};
   fi
done

# positional remain
node_name=$1
ip_address=$2

--param arg(スペース区切り)

スタイル--flag=value--flag valueスタイルを混ぜない方が通常は明確です。

./script.sh dumbo 127.0.0.1 --environment production -q -d

これは読むのが難しいですが、まだ有効です

./script.sh dumbo --environment production 127.0.0.1 --quiet -d

ソース

# process flags
pointer=1
while [[ $pointer -le $# ]]; do
   if [[ ${!pointer} != "-"* ]]; then ((pointer++)) # not a parameter flag so advance pointer
   else
      param=${!pointer}
      ((pointer_plus = pointer + 1))
      slice_len=1

      case $param in
         # paramter-flags with arguments
         -e|--environment) environment=${!pointer_plus}; ((slice_len++));;
                --another) another=${!pointer_plus}; ((slice_len++));;

         # binary flags
         -q|--quiet) quiet=true;;
                 -d) debug=true;;
      esac

      # splice out pointer frame from positional list
      [[ $pointer -gt 1 ]] \
         && set -- ${@:1:((pointer - 1))} ${@:((pointer + $slice_len)):$#} \
         || set -- ${@:((pointer + $slice_len)):$#};
   fi
done

# positional remain
node_name=$1
ip_address=$2

2

これは、最小限のコードで解析を実現し、サブストリング付きのevalを使用して、1つのケースで抽出したいものを定義できるgetoptsです。

基本的に eval "local key='val'"

function myrsync() {

        local backup=("${@}") args=(); while [[ $# -gt 0 ]]; do k="$1";
                case "$k" in
                    ---sourceuser|---sourceurl|---targetuser|---targeturl|---file|---exclude|---include)
                        eval "local ${k:3}='${2}'"; shift; shift    # Past two arguments
                    ;;
                    *)  # Unknown option  
                        args+=("$1"); shift;                        # Past argument only
                    ;;                                              
                esac                                                
        done; set -- "${backup[@]}"                                 # Restore $@


        echo "${sourceurl}"
}

ここでほとんどの答えとして、変数をグローバルではなくローカルとして宣言します。

次のように呼び出されます:

myrsync ---sourceurl http://abc.def.g ---sourceuser myuser ... 

$ {k:3}は基本的に---、キーから最初のものを削除するためのサブストリングです。


1

これも知っておくと便利です。値を設定し、誰かが入力を提供した場合は、その値でデフォルトを上書きできます。

myscript.sh -f ./serverlist.txtまたは単に./myscript.sh(およびデフォルトを使用)

    #!/bin/bash
    # --- set the value, if there is inputs, override the defaults.

    HOME_FOLDER="${HOME}/owned_id_checker"
    SERVER_FILE_LIST="${HOME_FOLDER}/server_list.txt"

    while [[ $# > 1 ]]
    do
    key="$1"
    shift

    case $key in
        -i|--inputlist)
        SERVER_FILE_LIST="$1"
        shift
        ;;
    esac
    done


    echo "SERVER LIST   = ${SERVER_FILE_LIST}"

1

getopt [s]、POSIX、古いUnixスタイルなしの別のソリューション

ブルーノブロノスキーがここに投稿たソリューションと同様に、を使用しないものですgetopt(s)

私のソリューションの主な差別化機能は、tar -xzf foo.tar.gzis is equal toと同じようにオプションを連結できることtar -x -z -f foo.tar.gzです。と同様にtarps短いオプションのブロックでは、先頭のハイフンはオプションです(ただし、これは簡単に変更できます)。長いオプションもサポートされています(ただし、ブロックが1つで始まる場合、2つの先行ハイフンが必要です)。

サンプルオプションを含むコード

#!/bin/sh

echo
echo "POSIX-compliant getopt(s)-free old-style-supporting option parser from phk@[se.unix]"
echo

print_usage() {
  echo "Usage:

  $0 {a|b|c} [ARG...]

Options:

  --aaa-0-args
  -a
    Option without arguments.

  --bbb-1-args ARG
  -b ARG
    Option with one argument.

  --ccc-2-args ARG1 ARG2
  -c ARG1 ARG2
    Option with two arguments.

" >&2
}

if [ $# -le 0 ]; then
  print_usage
  exit 1
fi

opt=
while :; do

  if [ $# -le 0 ]; then

    # no parameters remaining -> end option parsing
    break

  elif [ ! "$opt" ]; then

    # we are at the beginning of a fresh block
    # remove optional leading hyphen and strip trailing whitespaces
    opt=$(echo "$1" | sed 's/^-\?\([a-zA-Z0-9\?-]*\)/\1/')

  fi

  # get the first character -> check whether long option
  first_chr=$(echo "$opt" | awk '{print substr($1, 1, 1)}')
  [ "$first_chr" = - ] && long_option=T || long_option=F

  # note to write the options here with a leading hyphen less
  # also do not forget to end short options with a star
  case $opt in

    -)

      # end of options
      shift
      break
      ;;

    a*|-aaa-0-args)

      echo "Option AAA activated!"
      ;;

    b*|-bbb-1-args)

      if [ "$2" ]; then
        echo "Option BBB with argument '$2' activated!"
        shift
      else
        echo "BBB parameters incomplete!" >&2
        print_usage
        exit 1
      fi
      ;;

    c*|-ccc-2-args)

      if [ "$2" ] && [ "$3" ]; then
        echo "Option CCC with arguments '$2' and '$3' activated!"
        shift 2
      else
        echo "CCC parameters incomplete!" >&2
        print_usage
        exit 1
      fi
      ;;

    h*|\?*|-help)

      print_usage
      exit 0
      ;;

    *)

      if [ "$long_option" = T ]; then
        opt=$(echo "$opt" | awk '{print substr($1, 2)}')
      else
        opt=$first_chr
      fi
      printf 'Error: Unknown option: "%s"\n' "$opt" >&2
      print_usage
      exit 1
      ;;

  esac

  if [ "$long_option" = T ]; then

    # if we had a long option then we are going to get a new block next
    shift
    opt=

  else

    # if we had a short option then just move to the next character
    opt=$(echo "$opt" | awk '{print substr($1, 2)}')

    # if block is now empty then shift to the next one
    [ "$opt" ] || shift

  fi

done

echo "Doing something..."

exit 0

使用例については、以下の例を参照してください。

引数付きのオプションの位置

そこに価値があるのは、引数付きのオプションが最後になることではない(長いオプションだけが必要である)。したがって、たとえばtar(少なくとも一部の実装では)fファイル名が続く(tar xzf bar.tar.gz機能するがtar xfz bar.tar.gzそうではない)ため、オプションは最後にする必要があります(これは、ここでは当てはまりません(後の例を参照))。

引数付きの複数のオプション

別のボーナスとして、オプションパラメータは、必要なオプションを持つパラメータによってオプションの順序で消費されます。コマンドラインabc X Y Z(または-abc X Y Z)を使用して、ここでスクリプトの出力を確認してください。

Option AAA activated!
Option BBB with argument 'X' activated!
Option CCC with arguments 'Y' and 'Z' activated!

長いオプションも連結されます

また、オプションブロックに長いオプションを含めることもできます。したがって、次のコマンドラインはすべて同等です(オプションとその引数が処理される順序を含む)。

  • -cba Z Y X
  • cba Z Y X
  • -cb-aaa-0-args Z Y X
  • -c-bbb-1-args Z Y X -a
  • --ccc-2-args Z Y -ba X
  • c Z Y b X a
  • -c Z Y -b X -a
  • --ccc-2-args Z Y --bbb-1-args X --aaa-0-args

これらすべてが次の原因になります。

Option CCC with arguments 'Z' and 'Y' activated!
Option BBB with argument 'X' activated!
Option AAA activated!
Doing something...

このソリューションにはありません

オプションの引数

オプションの引数を持つオプションは、少しの作業で可能になるはずです。たとえば、ハイフンのないブロックがあるかどうかを楽しみにしています。ユーザーは、オプションのパラメーターを持つパラメーターを持つブロックに続くすべてのブロックの前にハイフンを置く必要があります。おそらくこれは複雑すぎてユーザーに伝えることができないので、この場合は先頭のハイフンを完全に必要とするだけです。

複数の可能なパラメーターがあるため、状況はさらに複雑になります。これは将来壊れる可能性があるので、引数がその引数に対するものかどうかを判断することでオプションを賢くしようとしないことをお勧めします(たとえば、オプションを使用すると、オプションの引数として数値をとるだけです)。

私はオプションの引数の代わりに追加のオプションを個人的に支持しています。

等号で導入されたオプション引数

オプションの引数と同じように、私はこれのファンではありません(ところで、さまざまなパラメータースタイルの賛否両論について議論するためのスレッドはありますか?)。ただし、これが必要な場合は、http://と同じように自分で実装できます。 mywiki.wooledge.org/BashFAQ/035#Manual_loop with --long-with-arg=?*case statement and then strip the equal sign(これはBTWのサイトですが、パラメータの連結はある程度の努力で可能ですが、読者のために「残しておきます」 「彼らは彼らの言葉に私を連れて行ったが、私はゼロから始めた)。

その他の注意事項

POSIX準拠、私が扱わなければならなかった古代のBusyboxセットアップでも動作します(例:cutheadおよびgetopts欠落)。

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.