Go by Example: Command-Line Subcommands

go や git のようなコマンドラインツールには多くの サブコマンド があり、それぞれが固有のフラグをもっています。 例えば、go build と go get は、go ツールの サブコマンドのうちの 2 つです。 flag パッケージを使うと、固有のフラグをもつシンプルな サブコマンドを簡単に定義できます。

 
package main
 
import (
    "flag"
    "fmt"
    "os"
)
 
func main() {

NewFlagSet 関数を使ってサブコマンドを宣言し、 続けてこのサブコマンド固有のフラグを定義します。

 
    fooCmd := flag.NewFlagSet("foo", flag.ExitOnError)
    fooEnable := fooCmd.Bool("enable", false, "enable")
    fooName := fooCmd.String("name", "", "name")

異なるサブコマンドに対して、異なるフラグを定義できます。

 
    barCmd := flag.NewFlagSet("bar", flag.ExitOnError)
    barLevel := barCmd.Int("level", 0, "level")

サブコマンドは、プログラムの最初の引数となる想定です。

 
    if len(os.Args) < 2 {
        fmt.Println("expected 'foo' or 'bar' subcommands")
        os.Exit(1)
    }

どのサブコマンドが呼ばれたか確認します。

 
    switch os.Args[1] {

各サブコマンドに対して、そのフラグをパースし、 残りの引数にアクセスします。

 
    case "foo":
        fooCmd.Parse(os.Args[2:])
        fmt.Println("subcommand 'foo'")
        fmt.Println("  enable:", *fooEnable)
        fmt.Println("  name:", *fooName)
        fmt.Println("  tail:", fooCmd.Args())
    case "bar":
        barCmd.Parse(os.Args[2:])
        fmt.Println("subcommand 'bar'")
        fmt.Println("  level:", *barLevel)
        fmt.Println("  tail:", barCmd.Args())
    default:
        fmt.Println("expected 'foo' or 'bar' subcommands")
        os.Exit(1)
    }
}
 
$ go build command-line-subcommands.go

まず、foo サブコマンドを実行します。

 
$ ./command-line-subcommands foo -enable -name=joe a1 a2
subcommand 'foo'
  enable: true
  name: joe
  tail: [a1 a2]

次に、bar を試します。

 
$ ./command-line-subcommands bar -level 8 a1
subcommand 'bar'
  level: 8
  tail: [a1]

ただし、bar は foo のフラグは受け付けません。

 
$ ./command-line-subcommands bar -enable a1
flag provided but not defined: -enable
Usage of bar:
  -level int
        level

次は、プログラムをパラメーター化する別の一般的な方法である、 環境変数を見ていきます。

Next example: Environment Variables.

by Mark McGranaghan and Eli Bendersky (translated by @oohira) | feedback | license