コマンドライン引数を設計するための良い習慣は何ですか？

アプリケーションの開発中、私は疑問に思い始めました-コマンドライン引数をどのように設計する必要がありますか？

プログラムの多くは、このように式を使用しています-argument valueか/argument value。私の頭に浮かんだ解決策はargument:value。空白がないと、値と引数を台無しにする方法がないので、良いと思いました。また、左の:文字から最初の文字列を2つに分割するのは簡単です。

私の質問は：

1. 人気のある-argument value式はargument:value、より読みやすく、書きやすく、バグがなく、専門の開発者が理解しやすいですか？
2. コマンドライン引数を設計する際に従うべき一般的に知られているいくつかのルールはありますか（動作する場合は問題ありません）？

詳細を尋ねられたので提供します。ただし、回答に影響を与えるべきではないと思います。質問は一般的に良い習慣についてです。それらはすべての種類のアプリケーションで同じだと思います。

私たちは、公共の場所（タッチトーテム、テーブル）で使用されるアプリケーションに取り組んでいます。アプリケーションは、Qt Quick 5（C ++、QML、JS）を使用して記述されています。デバイスにはWindows 8.1 / 10がインストールされます。デバイスを管理するためのフロントエンドインターフェイスを提供します。ただし、一部の上級管理者は、自分でアプリケーションを構成することができます。ビジネスの観点からはそれほど重要ではありませんが、Kilian Fothが言ったことに同意するように、自分のアプリケーションがユーザーの苦痛になりたくないのです。私がここで尋ねたものをインターネットで見つけられない。

より高度なStack Exchangeユーザーへ：この質問を一般的なものにしたかった。コミュニティWikiに該当する可能性があります（既存の質問を回答で変換できるかどうかはわかりません）。この質問をオペレーティングシステムとプログラミング言語に依存しないようにしたいので、ここに表示される答えは他の開発者にとって貴重な教訓になります。

POSIXシステム（Linux、MacOSXなど）では、少なくともシェルターミナルで起動される可能性のあるプログラム（たとえばそれらのほとんど）については、GNUコーディング規則（一般的な引数名もリストします）を使用し、POSIXユーティリティガイドラインを調べることをお勧めします、プロプライエタリなソフトウェアでも：

• 常に扱い--versionと--help（でも/bin/true、それらを受け入れる!!）。私は理解していないソフトウェアの作者を呪います--help、私は彼らを嫌います（なぜならprog --help 、私は新しいプログラムで試みている最初のコマンドだからです！）多くの--help場合、略すことができます-h

• 持っている--help（あなたが最も一般的なものと、その場合リストに...それらのあまりに多くを持っていない限り、すべてのオプションのメッセージのリストを明示的には、いくつかを参照manし、オプションのデフォルト値ページまたは一部のURL）、そしておそらく重要な（とプログラム固有） 環境変数。オプション引数エラーでこれらのオプションリストを表示します。

• 受け入れ-a短い引数（単一の文字）を、いくつか同等のものを持っている--long-argumentので-a2 --long-argument=2、--long-argument 2。もちろん、（めったに使用されないオプションのために）何らかの--only-long-argument名前を持つことができます。追加のオプションのないモーダル引数の場合-cf、一般的-c -fになどとして処理されるため、あなたの-argument:value提案は奇妙であり、それを行うことはお勧めしません。

• GLIBC getopt_long以上を使用します（例：argp_parse、OCamlではArgモジュール、...）

• 頻繁に使用する-（あなたがそれを行うことができない場合、取り扱う標準入力または出力のために/dev/stdin＆/dev/stdoutさらにいくつかのオペレーティング・システム上でそれらを持っていません）

• オプションの規則のほとんどを再利用することにより、同様のプログラムの動作を模倣します。特に-n、ドライラン（アラmake）、-hヘルプ、-v冗長性などのために...

• --オプションとファイルまたは他の引数の間のセパレータとして使用

• プログラムisattyがstdinがターミナルであるよりもテストするために使用する場合（およびその場合は「対話的に」動作する）、プログラムにGUIインターフェースがある（およびgetenv("DISPLAY")X11デスクトップでテストする）場合と同様に、非対話モードを強制するオプションを提供するバッチまたはコマンドラインで使用されます。

• 一部のプログラム（例gcc）は間接引数リストを受け入れます。@somefile.txtつまり、プログラム引数をsomefile.txt; から読み取ることを意味します。これは、プログラムが非常に多くの引数（カーネルの引数を超えるARG_MAX）を受け入れる場合に便利です。

ところで、あなたのプログラムと通常のシェル（bashまたはのようなzsh）にオートコンプリート機能を追加することもできます。

いくつかの古いUnixコマンド（例えばdd、またはsed）には、歴史的な互換性のために奇妙なコマンド引数があります。私は彼らの悪い習慣に従わないことをお勧めします（あなたがそれらのより良い変種を作っているのでない限り）。

お使いのソフトウェアは、関連するコマンドラインプログラムのシリーズからインスピレーションを取る場合にはgitの受け入れ（あなたはきっと開発ツールとして使用）、git helpそしてgit --help、多くのを持っているgitsubcommandし、gitsubcommand--help

まれargv[0]に、（プログラムでシンボリックリンクを使用して）を使用することもあります。たとえば、異なる動作（制限されたシェル）bashとして起動されrbashます。しかし、私は通常、そうすることはお勧めしません。プログラムがshebangを使用するスクリプトインタープリターとして、つまりexecve（2）によって解釈される最初の行で使用できる場合、それは理にかなっているかもしれません。このようなトリックを行う場合は、メッセージを含めてそれらを文書化してください。#!--help

POSIXでは、シェルは（プログラムを実行する前に）引数をグロブしていることに注意してください。したがって、シェルエスケープする必要があるオプション（またはなど）の文字を要求しないでください。*$~

場合によっては、GNU guileやLuaなどのインタープリターをソフトウェアに埋め込むことができます（プログラミング言語の専門家でない場合は、独自のチューリング完全なスクリプト言語を発明しないでください）。これは、ソフトウェアの設計に大きな影響を及ぼします（したがって、早期に検討する必要があります！）。そうすれば、簡単にスクリプトまたは式をそのインタープリターに渡すことができるはずです。その興味深いアプローチをとる場合は、ソフトウェアとその解釈されるプリミティブを慎重に設計してください。あなたはあなたのために大きなスクリプトをコーディングする奇妙なユーザーを持つことができます。

他の例では、あなたは、高度なユーザーが自分のロードせたいかもしれないプラグインを（使用して、ソフトウェアに動的ロードラà技術dlopen＆をdlsym）。繰り返しになりますが、これは非常に重要な設計上の決定です（したがって、プラグインインターフェイスを慎重に定義および文書化します）。これらのプラグインにプログラムオプションを渡すための規則を定義する必要があります。

ソフトウェアが複雑な場合は、いくつかの構成ファイル（プログラム引数の追加または置換）を受け入れ、おそらくすべてのコードを実行せずにこれらの構成ファイルをテスト（または単に解析）する方法があります。たとえば、メール転送エージェント（EximやPostfixなど）は非常に複雑であり、「ハーフドライ」で実行できると便利です（たとえば、実際にメールを送信せずに特定のメールアドレスを処理する方法を観察できます）。

^{/optionはWindowsまたはVMSのものであることに注意してください。これは、POSIXシステムでは正気ではありません（ファイル階層が/ディレクトリセパレータとして使用するため、またシェルがグロビングを行うため）。私の答えはほとんどがLinux（およびPOSIX）に対するものです。}

PS可能であれば、プログラムをフリーソフトウェアにします。一部のユーザーと開発者から改善が得られます（そして、新しいプログラムオプションを追加することは、多くの場合、既存のフリーソフトウェアに追加する最も簡単なものの1つです）。また、あなたの質問は対象となる視聴者に大きく依存します。ティーンエイジャー向けのゲームやおばあちゃん向けのブラウザは、おそらくコンパイラ、データセンターのシステム管理者向けのネットワークインスペクタ、またはマイクロプロセッサ用のCADソフトウェアと同じ種類と量のオプションを必要としません建築家または橋梁設計者向け。プログラミングとスクリプティングに精通しているエンジニアは、おばあちゃんよりも多くの調整可能なオプションを持っていることを好み、おそらくX11なしで（おそらくcrontab仕事中に）アプリケーションを実行したいと思うかもしれません。

データ形式の規則が一般的であるという事実は、その利点です。

=または：または ''をセパレータとして使用することは些細な違いであり、コンピューターで簡単に変換できることは簡単にわかります。何だろう、大きな努力することは、人間が覚えておくためである、「この頻度の低い-使用するプログラムは、で物事を区切るやった、参照今:かと=？うーん...」

言い換えれば、神の愛のために、説得力のある理由なしに非常に定着した慣習から逸脱しないでください。あなたのプログラムは、「私の大学のエッセイを保存したもの」ではなく、「奇妙で迷惑なcmdline構文を持つもの」として記憶されます。

素人の言葉で

ローマにいるときは、ローマ人と同じようにしてください。

• CLIアプリがLinux / Unixを対象としている場合は、-p valueまたはの--parameter value規則を使用してください。Linuxには、このようなパラメーターとフラグを簡単な方法で解析するためのツールがあります。

私は通常このようなことをします：

while [[ $# > 0 ]]
do
key="$1"
case $key in
    --dummy)
    #this is a flag do something here
    ;;
    --audit_sessiones)
    #this is a flag do something here
    ;;
    --destination_path)
    # this is a key-value parameter
    # the value is always in $2 , 
    # you must shift to skip over for the next iteration
    path=$2
    shift
    ;;
    *)
    # unknown option
    ;;
esac
shift
done

• CLIアプリがWindowsを対象としている場合、使用/flagおよび/flag:value規則。

• ただし、Oracleなどの一部のアプリはどちらも使用しません。Oracleユーティリティはを使用しますPARAMETER=VALUE。

• 私がやりたいことの1つは、コマンドラインでパラメーターを受け入れることに加えて、長いパラメーターチェーンを回避するためのキーと値のペアファイルであるparfileを使用するオプションを提供することです。そのためには、追加の--parfile mifile.parパラメーターを指定する必要があります。を--parfile使用する場合、明らかに、他のすべてのパラメーターは破棄され、parfile内の内容が優先されます。

• 追加の提案は、いくつかのカスタム環境変数の使用を許可することです。たとえば、環境変数MYAPP_WRKSPACE=/tmpを設定すると、常に設定する必要がなくなります--wrkspace /tmp。

• Linuxでは、パラメーターauto-completionを追加することを忘れないでください。これは、ユーザーがスイッチの半分を入力し、ヒットするTABと、シェルがそれを完了することを意味します。

まだ出てこなかったことが1つあります。

コマンドライン引数から上向きにソフトウェアを設計してください。意味：

機能を設計する前に、ユーザーインターフェイスを設計します。

これにより、エッジケースと一般的なケースを早期に掘り下げることができます。もちろん、外側と内側を抽象化しますが、すべてのコードを記述してからCLIを非難するよりもはるかに良い結果が得られます。

さらに、docopt（http://docopt.org/）を確認してください。

docoptは、多くの言語、特にargparseのようなユーザーに反する引数パーサーがまだ「OK」と見なされている場合に、Pythonで非常に役立ちます。パーサーとサブパーサーと条件付き辞書を使用する代わりに、構文ヘルプを定義するだけで残りは処理されます。

いくつかの貴重なコメント（@ Florian、Basile）が既に提供されていますが、私に付け加えてください... OPは言います、

デバイスを管理するためのフロントエンドインターフェイスを提供します。ただし、一部の上級管理者は、自分でアプリケーションを構成することができます。

ただし、次のことも注意してください。

この質問をプラットフォームや言語固有のものにしたくない

ターゲットオーディエンス（上級管理者）を考慮する必要があります。通常、どのプラットフォームで動作しますか-Win / Unix / Mac？アプリはどのプラットフォームで実行されますか？そのプラットフォーム用にすでに確立されているCLI規約に従ってください。「上級」管理者は、GUIベースのツールを必要としていますか、それとも必要ですか。

インターフェイスは、内部および他の管理ツールと一貫性が必要です。私は停止し、それだと思うしたくないcmd -p <arg>か、cmd -p:<arg>またはcmd /p <arg>。スペースがあるので引用符が必要ですか？私はできcmd -p <val1> <val2>またはcmd -p <val1> -p <val2>複数のターゲットのために？彼らは特定の注文ですか？オーバーロード可能？cmd -p2 <arg> -p1 <arg>あまりにも動作しますか？ls -l -r -t dir1 dir2== ls -trl dir1 dir2？

Unix管理ツールについては、言及されている他の参考文献とともに、HeinerのShelldoradoが提供するガイダンスを常に念頭に置いています。

CLIを設計するのと同じくらい重要なのは、アプリケーションがGUIと同じコマンドライン引数で動作するように設計することです。つまり、GUIにビジネスロジックがないか、GUIとCLIの両方から呼び出される共通コマンドを使用します。

ほとんどのUNIXベースの管理ツールは、実際には最初にコマンドラインツールとして設計されており、提供されているGUIにより、コマンドラインのオプションを簡単に「入力」できます。そのアプローチにより、自動化、応答ファイルの使用など、およびハンドオフ管理が可能になります（私にとってはあまり手間がかかりません！）

このアプローチで使用される古典的なツールセットはTcl / Tkです。ツールを切り替えることを提案していません。GUIベースの管理アプリをコマンドラインツールとしてアプリに最初に記述することから、設計アプローチを検討してください。次に、利便性のためにGUIを上に重ねます。複数の設定を行い、一般的に同じオプションを何度も再入力する必要がある場合は、GUIが苦痛（およびエラーが発生しやすい）になることを発見する可能性があり、自動化されたアプローチを探します。

とにかく管理者が正しいボックスに正しい値を入力しなければならない可能性が高いことを覚えておいてください。