clibase

README

📚 CLI Base

clibase は、Go言語でコマンドラインインターフェース (CLI) アプリケーションを迅速に構築するための、spf13/cobra ベースの共通基盤を提供するパッケージです。

✨ 特徴

• cobra ベース: 強力なCLI構築ライブラリ spf13/cobra を基盤としています。
• 構造体による宣言的定義: clibase.App 構造体に必要な要素を渡すだけで、ボイラープレートを排除した綺麗な main 関数を実現します。
• 柔軟なカスタマイズ: アプリケーション固有のフラグ定義や、実行前チェック（例: 環境変数や認証の確認）を簡単に注入できます。
• 共通フラグの標準提供: verbose (-V) と config (-C) の2つの永続フラグを標準で提供。
• グローバル設定アクセス: 共通フラグの値には clibase.GlobalConfig を通じてアプリケーションのどこからでもアクセス可能です。

---

🛠️ インストール

go get github.com/shouni/clibase

---

🚀 使用方法

1. アプリケーションの構築と実行

clibase.App を使って、フラグ、チェックロジック、サブコマンドを集約します。

// main.go
package main

import (
    "fmt"
    "os"

    "github.com/shouni/clibase"
    "github.com/spf13/cobra"
)

var customAPIKey string

func main() {
    clibase.Execute(clibase.App{
        Name: "my-app",
        
        // (1) アプリ固有の永続フラグを追加
        AddFlags: func(rootCmd *cobra.Command) {
            rootCmd.PersistentFlags().StringVar(&customAPIKey, "api-key", "", "API Key for authentication")
        },

        // (2) 実行前チェック（共通処理の後に実行されます）
        PreRunE: func(cmd *cobra.Command, args []string) error {
            if customAPIKey == "" && os.Getenv("APP_API_KEY") == "" {
                return fmt.Errorf("--api-key or APP_API_KEY environment variable is required")
            }
            return nil
        },

        // (3) サブコマンドの追加
        Commands: []*cobra.Command{
            helloCmd,
        },
    })
}

var helloCmd = &cobra.Command{
    Use:   "hello",
    Short: "Prints a greeting",
	Run: func(cmd *cobra.Command, args []string) {
		fmt.Println("Hello!")
		// 共通フラグの値を確認
		cfg := clibase.GetConfig()
		if cfg.Verbose {
			fmt.Printf("Debug: Config file is %s\n", cfg.ConfigFile)
		}
	},
}

---

⚙️ 提供される機能

共通フラグ

すべてのコマンドで以下のフラグが自動的に利用可能になります。

フラグ	短縮形	用途	アクセス方法
--verbose	-V	詳細ログの有効化	clibase.GlobalConfig.Verbose
--config	-C	設定ファイルのパス指定	clibase.GlobalConfig.ConfigFile

内部構造: clibase.App

アプリケーションの構成を定義する中心的な構造体です。

type App struct {
    Name     string                                    // アプリ名
    AddFlags func(cmd *cobra.Command)                  // フラグ登録フック
    PreRunE  func(cmd *cobra.Command, args []string) error // 実行前チェックフック
    Commands []*cobra.Command                          // サブコマンド
}

---

📜 ライセンス (License)

このプロジェクトは MIT License の下で公開されています。

---

Documentation

Index

• func Execute(app App)
• type App
• type Config
  • func GetConfig() Config

Functions

func Execute

func Execute(app App)

Execute は、アプリケーションの構築と実行をワンストップで行います。

Types

type App

type App struct {
	Name     string
	AddFlags func(cmd *cobra.Command)
	PreRunE  func(cmd *cobra.Command, args []string) error
	Commands []*cobra.Command
}

App は CLI アプリケーションの構成を定義します。

type Config

type Config struct {
	Verbose    bool
	ConfigFile string
}

Config は共通フラグの値を保持する内部構造体です。

func GetConfig

func GetConfig() Config

GetConfig は現在の設定情報のコピーを返します。