Go でイケてる CLI を作るために利用したパッケージ
先日、 cLive というターミナルを自動操作する Go 製のコマンドラインツールを公開しました。
cLive で JavaScript のライブコーディングをするデモ
この記事では Go でイケてる感じの CLI を作るために利用したパッケージを簡単に紹介します。
cLive については以下の記事をご参照ください。
利用したパッケージ
- Cobra : CLI フレームワーク
- Bubble Tea : TUI フレームワーク
- GoReleaser : リリース自動化
Cobra
Cobra は Go の CLI アプリケーションフレームワークです。
フラグの取り扱いやサブコマンド、ヘルプなどといったよくある CLI の機能を簡単に実装することができます。
例えば、以下のコードは --toggle, -t という bool 型のフラグを持つ example コマンドを実装するサンプルコードです。
package main
import (
"fmt"
"os"
"github.com/spf13/cobra"
)
var rootCmd = &cobra.Command{
Use: "example",
Long: "コマンドの説明",
// メイン処理
RunE: func(cmd *cobra.Command, args []string) error {
// フラグを取得
t, err := cmd.Flags().GetBool("toggle")
if err != nil {
return err
}
fmt.Printf("toggle: %t", t)
return nil
},
}
func main() {
err := rootCmd.Execute()
if err != nil {
os.Exit(1)
}
}
func init() {
// フラグの追加
// bool 型の --toggle, -t フラグを設定
rootCmd.Flags().BoolP("toggle", "t", false, "フラグの説明")
}
# フラグを指定せずに実行
$ go run ./main.go
toggle: false
# フラグを指定して実行①
$ go run ./main.go --toggle
toggle: true
# フラグを指定して実行②
$ go run ./main.go -t
toggle: true
# help を表示
$ go run ./main.go --help
コマンドの説明
Usage:
example [flags]
Flags:
-h, --help help for example
-t, --toggle フラグの説明
このように、それっぽい感じの CLI をサクッと作ることができます。
また、 Cobra には cobra-cli という開発用の便利な CLI が用意されています。
cobra-cli を使うことで Cobra CLI アプリケーションの初期化やサブコマンドの追加などといった作業を簡単に行うことができます。
# モジュールを初期化
$ go mod init <任意のモジュール名>
# Cobra アプリケーションを初期化
$ cobra-cli init
# 色々生成される
$ tree
.
├── LICENSE
├── cmd
│ └── root.go
├── go.mod
├── go.sum
└── main.go
1 directory, 5 files
# `hello` サブコマンドを追加
$ cobra-cli add hello
# cmd/hello.go が作成される
$ tree
.
├── LICENSE
├── cmd
│ ├── hello.go
│ └── root.go
├── go.mod
├── go.sum
└── main.go
1 directory, 6 files
main.go
/*
Copyright © 2023 NAME HERE <EMAIL ADDRESS>
*/
package main
import "example/cmd"
func main() {
cmd.Execute()
}
cmd/root.go
/*
Copyright © 2023 NAME HERE <EMAIL ADDRESS>
*/
package cmd
import (
"os"
"github.com/spf13/cobra"
)
// rootCmd represents the base command when called without any subcommands
var rootCmd = &cobra.Command{
Use: "example",
Short: "A brief description of your application",
Long: `A longer description that spans multiple lines and likely contains
examples and usage of using your application. For example:
Cobra is a CLI library for Go that empowers applications.
This application is a tool to generate the needed files
to quickly create a Cobra application.`,
// Uncomment the following line if your bare application
// has an action associated with it:
// Run: func(cmd *cobra.Command, args []string) { },
}
// Execute adds all child commands to the root command and sets flags appropriately.
// This is called by main.main(). It only needs to happen once to the rootCmd.
func Execute() {
err := rootCmd.Execute()
if err != nil {
os.Exit(1)
}
}
func init() {
// Here you will define your flags and configuration settings.
// Cobra supports persistent flags, which, if defined here,
// will be global for your application.
// rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.example.yaml)")
// Cobra also supports local flags, which will only run
// when this action is called directly.
rootCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
}
cmd/hello.go
/*
Copyright © 2023 NAME HERE <EMAIL ADDRESS>
*/
package cmd
import (
"fmt"
"github.com/spf13/cobra"
)
// helloCmd represents the hello command
var helloCmd = &cobra.Command{
Use: "hello",
Short: "A brief description of your command",
Long: `A longer description that spans multiple lines and likely contains examples
and usage of using your command. For example:
Cobra is a CLI library for Go that empowers applications.
This application is a tool to generate the needed files
to quickly create a Cobra application.`,
Run: func(cmd *cobra.Command, args []string) {
fmt.Println("hello called")
},
}
func init() {
rootCmd.AddCommand(helloCmd)
// Here you will define your flags and configuration settings.
// Cobra supports Persistent Flags which will work for this command
// and all subcommands, e.g.:
// helloCmd.PersistentFlags().String("foo", "", "A help for foo")
// Cobra supports local flags which will only run when this command
// is called directly, e.g.:
// helloCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
}
その他 Cobra でできることについては公式の README をご参照ください。
Bubble Tea
Bubble Tea は Charm が開発している Go 製の TUI フレームワークです。
見た目が綺麗で機能的な UI を簡単に実装することができます。
The Elm Architecture をベースにしているらしいので、 Elm を使い慣れている人は使いやすいかもしれません。
以下は cLive を実行しているときの UI ですが、これは Bubble Tea を使って実装しています。
cLive の UI
サンプルコードや実際にどういったことができるのかなどは、公式の Examples が非常に充実しているのでこちらをご参照ください。
例えば以下のようなサンプルが用意されています。
また、 Bubble Tea 専用のコンポーネントライブラリである Bubbles や、綺麗なスタイルをレンダリングするための Lip Gloss などといったライブラリも提供されています。
詳しくは公式の README をご参照ください。
ちなみに Charm は他にも gum や VHS などの様々なイケてる CLI やライブラリ等を公開しているので、興味があればこちらもご参照ください。
GoReleaser
cLive では GitHub リリースや Homebrew Tap の作成を GoReleaser を使用して自動化しています。
GoReleaser は Go プロジェクトのリリースを自動化するツールです。
GitHub・GitLab・Gitea へのリリースの他、 Linux パッケージや Homebrew Tap の作成など、 Go プロジェクトのリリースに関する様々なタスクを自動化することができます。
基本的には CI 上で実行されることを想定していますが、ローカルでも実行可能です。
GitHub Actions を利用する場合、公式の Action が用意されているため、こちらを使うことで簡単にリリースの自動化を行うことができます。
もちろん GitHub Actions だけでなく他にも様々な CI ランナー上で利用することが可能です。
詳しい使い方については公式ドキュメントをご参照ください。
まとめ
めちゃくちゃ便利！！！！！
Discussion