每個好的CLI應用程序必須具備哪些基本參數？

Question

myapp /？

MYAPP -help

MYAPP -ver

等....

Answer 1

GNU Coding Standards要求--version和--help我期待任何CLI程序來支持這些。除此之外，這取決於程序是什麼，但這裏有一些其他建議：-q或--quiet用於較少輸出，-v或--verbose用於更多輸出，-d或--debug用於調試輸出。

Answer 2

的命令行參數的短期和長期的版本。檢查您使用的編程語言是否有getopt庫端口。它會幫助你解析命令行參數。

--config-file=FILE | -C FILE 
--help | -h 
--usage | -u 
--version | -v 

包括您的應用程序的其他相關選項。

Answer 3

我建議有幫助，版本，輸出詳細設置的選項。其他開關取決於您的應用程序。

Answer 4

這取決於平臺。

在Windows上，/？或/ h或/幫助是常見的。

在Unix上，一個命令應該有一個手冊頁。

在遵循Gnu慣例（例如Linux）的Unix變體中，它應該響應--help和--version。更好的是，它可以與bash自動完成集成。

除此之外，請查看其他程序與您的相同區域，並在有意義的地方使用相同的選項。例如：

• -R/- 遞歸遞歸下降目錄
• -q/- 靜音抑制輸出
• -v/- 詳細生成詳細的診斷輸出
• -n在不改變任何東西

如果你的程序接受文件名作爲參數來執行，然後通常的慣例是一個連字符來表示和雙連字符「從標準輸入讀」指「治療的一個參數爲即使文件它以連字符開頭「。

Answer 5

-h是必須在* nix上。我會說相同的/？在Windows上，但兩種平臺可用的程序通常用於* nix風格。這可能是因爲getopt和朋友。

一些要領：

-h, --help 
-v, --version 
-u, --usage 

如果應用程序修改的任何文件都：

--dry-run Do not modify any files (but work as if you did) 

如果應用程序使用配置文件，選擇要使用指定的配置文件或目錄。

一些主要業務切換到非交互方式運行，並做的工作：

mysql --execute="SELECT * FROM ..." 
cmd.exe /C "dir" 

Answer 6

埃裏克雷蒙給出了他的偉大著作The Art of Unix Programming最常見的UNIX命令行選項的很好的概述。它主要討論單字母選項，但是在這方面還是一個很好的資源。

Answer 7

我同意上面提到的所有參數，但想指出另一件事：您可能希望您的應用程序接受所有參數的長，短和BSD樣式。當然，如果你覺得你的用戶都不會樂於使用它，BSD風格可能會被忽略。長時間的風格有助於增加參數的含義，並使它們在開始使用應用程序時更容易記住。