Tbpgr Blog

Ruby プログラマ tbpgr(てぃーびー) のブログ

Ruby | CLI | Be Helpful | Documenting a Command-Line Interface

概要

書籍 Build Awesome Command-Line Applications in Ruby2

Be Helpful

詳細

コマンドラインの経験のあるユーザーは、コマンドラインをどう使うか知るために
次のことを試します。

彼らは引数なしでコマンドを実行するか、 help スイッチを呼び出す。(-h か --help)
ユーザーは、
・どんな引数があるか
・どんなオプションを利用できるか
など、CLIアプリケーションの利用方法の要約を期待しています。

OptionParserやThorはヘルプに対応しているため、下記の記事で出力を確認できます

Ruby | CLI | Be Easy to Use | Ruby | CLI | Be Easy to Use | OptionParserを利用した使いやすいCLIインターフェース
http://d.hatena.ne.jp/tbpg/20140526/1401109608

$ ruby 1.rb --help
Usage: up_down_converter [options]
    -u, --upcase                     大文字に変換します
    -d, --downcase                   小文字に変換します
    -t, --text=TEXT                  テキストを指定します

Ruby | CLI | Be Easy to Use | Thorを利用した使いやすいCommand suitインターフェース
http://d.hatena.ne.jp/tbpg/20140526/1401109675

$ ruby personal.rb
person_viewer commands:
  personal.rb find by firstname [FIRSTNAME]  # find by firstname [FIRSTNAME]
  personal.rb help [COMMAND]                 # Describe available commands or...
  personal.rb version                        # version
  personal.rb view age                       # view age
  personal.rb view firstname                 # view firstname
  personal.rb view fullname                  # view fullname
  personal.rb view lastname                  # view lastname

Options:
  -h, [--help], [--no-help]        # help message.
      [--version], [--no-version]  # version