GoでCLIツールを作る方法｜Cobraフレームワークで効率的に実装

2026年4月4日2026年4月5日

Go言語でCLIツールを開発してみたいけど、どこから始めたら良いのか分からない…そんな方へ、今回はCobraというGoの強力なCLIフレームワークを使った、プロフェッショナルなCLIツール開発の方法をご紹介します。Cobraを使うことで、複雑なコマンド構造やフラグ管理も簡単に実装できると思います。

GoでCLIツールを作るメリット

Go言語でCLIツールを開発することには、実はかなりの利点があるんですよね。

コンパイル言語による高速実行：起動時間が短く、システムツールに最適
単一バイナリ：依存関係がなく、配布が簡単
クロスプラットフォーム対応：Windows、macOS、Linuxで同じコードで動作
豊富なライブラリ：Cobraをはじめ、CLIツール開発に必要なツールが充実
シンプルな構文：学習曲線が緩く、保守性が高い

Cobraフレームワークとは

Cobraは、Go言語でCLIアプリケーションを構築するための最も人気のあるフレームワークで、Docker、Kubernetes、Hugoなど、有名なプロジェクトでも採用されています。調べてみたら、こんなに多くの有名プロジェクトで使われているんだと驚きました。

Cobraの主な特徴

サブコマンド対応：階層的なコマンド構造を簡単に実装
フラグ・オプション管理：–helpや–versionなどの自動生成
シェル補完機能：bash、zsh、fishなどに対応
ドキュメント自動生成：Markdown形式のドキュメントを自動作成
わかりやすいAPI：シンプルで直感的なインターフェース

環境構築と初期セットアップ

まずは、Goがインストールされた環境を用意してください。バージョン1.16以上を推奨します。

プロジェクトの初期化

mkdir my-cli-tool
cd my-cli-tool
go mod init github.com/username/my-cli-tool

Cobraのインストール

go get -u github.com/spf13/cobra@latest
go install github.com/spf13/cobra-cli@latest

Cobraスケルトン生成

Cobraには、CLIプロジェクトの雛形を自動生成するツールが用意されているんですよ。これを活用すると、初期セットアップが大幅に簡略化されて、かなり時間を短縮できます。

cobra-cli init
cobra-cli add greet
cobra-cli add farewell

これらのコマンドにより、以下のようなディレクトリ構造が自動生成されます：

.
├── cmd
│   ├── greet.go
│   ├── farewell.go
│   └── root.go
├── main.go
├── go.mod
└── go.sum

シンプルなCLIツールの実装例

実際に、「greet」というコマンドを実装してみましょう。このツールは、ユーザーに挨拶をするシンプルな機能を持つと思います。

main.go の作成

package main

import (
	"fmt"
	"os"

	"github.com/username/my-cli-tool/cmd"
)

func main() {
	if err := cmd.RootCmd.Execute(); err != nil {
		fmt.Println(err)
		os.Exit(1)
	}
}

root.go の実装

ルートコマンドは、CLIツール全体の親コマンドとなるんですね。バージョンやヘルプ情報を定義することで、全体の基礎が整います。

package cmd

import (
	"fmt"
	"github.com/spf13/cobra"
)

var RootCmd = &cobra.Command{
	Use:   "my-cli-tool",
	Short: "シンプルなCLIツール",
	Long: `my-cli-toolは、Goで作成されたシンプルなCLIツールです。
複数のコマンドを実行できます。`,
	Version: "1.0.0",
	Run: func(cmd *cobra.Command, args []string) {
		fmt.Println("my-cli-toolへようこそ！")
	},
}

func Execute() error {
	return RootCmd.Execute()
}

greet.go のサブコマンド実装

次に、ユーザーに名前を渡して挨拶をするサブコマンドを実装します。フラグを使用することで、ツールのカスタマイズ性が高まるんです。

package cmd

import (
	"fmt"
	"github.com/spf13/cobra"
)

var name string

var greetCmd = &cobra.Command{
	Use:   "greet",
	Short: "ユーザーに挨拶します",
	Long: `greetコマンドは、指定されたユーザーに挨拶をします。
--nameフラグで名前を指定してください。`,
	Run: func(cmd *cobra.Command, args []string) {
		if name == "" {
			name = "World"
		}
		fmt.Printf("こんにちは、%s さん!\n", name)
	},
}

func init() {
	RootCmd.AddCommand(greetCmd)
	greetCmd.Flags().StringVarP(&name, "name", "n", "", "挨拶する相手の名前")
}

ビルドと実行方法

プロジェクトをビルドして、実行可能ファイルを生成していきます。

ビルドコマンド

go build -o my-cli-tool

実行例

./my-cli-tool greet --name Taro

こんにちは、Taro さん!

ヘルプ表示

./my-cli-tool --help
./my-cli-tool greet --help

高度な機能の活用

フラグの種類

Cobraでは、様々な種類のフラグをサポートしているんですよ。それぞれの用途に応じて使い分けることになります。

String フラグ：--name "John"
Int フラグ：--count 5
Bool フラグ：--verbose
Slice フラグ：--tags tag1,tag2

フラグの実装例

var verbose bool
var count int

func init() {
	cmd.Flags().BoolVarP(&verbose, "verbose", "v", false, "詳細な出力")
	cmd.Flags().IntVarP(&count, "count", "c", 1, "実行回数")
}

シェル補完の設定

シェル補完機能を有効にすると、ユーザーがTabキーでコマンドを補完できるようになります。これはユーザー体験を大きく向上させるんです。

# Bash補完の有効化
source <(my-cli-tool completion bash)

# Zsh補完の有効化
source <(my-cli-tool completion zsh)

クロスプラットフォームビルド

Goの大きなメリットの一つが、複数のプラットフォーム向けに簡単にビルドできることです。公式ドキュメントによると、環境変数を指定するだけで対応できます。

# Linux版
GOOS=linux GOARCH=amd64 go build -o my-cli-tool-linux

# macOS版
GOOS=darwin GOARCH=amd64 go build -o my-cli-tool-macos

# Windows版
GOOS=windows GOARCH=amd64 go build -o my-cli-tool.exe

デバッグとテスト

ロギングの追加

本番環境での問題解決のためには、ロギングを追加することが重要だと実装していて気づきました。開発段階でこれを仕込んでおくと、後々かなり役立ちます。

import "log"

func init() {
	greetCmd.PreRun = func(cmd *cobra.Command, args []string) {
		log.Printf("greetコマンドを実行しています。名前: %s", name)
	}
}

ユニットテストの例

package cmd

import "testing"

func TestGreet(t *testing.T) {
	// テストコード
}

まとめ

Go言語とCobraを使用することで、効率的でプロフェッショナルなCLIツールを開発できるんです。以下が本記事の重要なポイントになります。

CobraはGo言語でCLIツール開発を効率化する強力なフレームワーク
サブコマンドとフラグ管理が簡単に実装でき、可読性の高いコードになる
単一バイナリで配布できるため、ユーザーの導入が簡単
クロスプラットフォーム対応で、複数OS向けビルドも容易
ヘルプやシェル補完の自動生成により、ユーザー体験を向上させられる
Go言語の高速性により、大規模なデータ処理も高速に実行可能

次は、実際にプロジェクトを立ち上げて、自分のアイデアを形にしてみてください。Cobraの柔軟性と使いやすさなら、あなたの想像を実現できると思います。

よかったらシェアしてね！

URLをコピーしました！

URLをコピーしました！