command

README

Reusable Command Line Options

for spf13/cobra-based CLI tools

This package provides reusable command line options and configuration patterns for Carabiner CLI tools. It defines the OptionsSet interface for composable CLI flag management and provides common option sets that can be shared across multiple commands and applications.

Available OptionsSets

log - Logging Configuration

Package: github.com/carabiner-dev/command/log

Provides structured logging configuration with --log-level flag supporting debug, info, warn, and error levels. Includes WithLogger(ctx) method to initialize and inject logger into context.

Usage:

import "github.com/carabiner-dev/command/log"

logOpts := &log.Options{}

rootCmd := &cobra.Command{
    Use: "myapp",
    PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
        ctx, err := logOpts.WithLogger(cmd.Context())
        if err != nil {
            return err
        }
        cmd.SetContext(ctx)
        return nil
    },
}

logOpts.AddFlags(rootCmd)

keys - Public Key File Management

Package: github.com/carabiner-dev/command/keys

Provides public key file path configuration with --key/-k flag. Validates key file existence and parses keys into key.PublicKeyProvider instances.

Usage:

import "github.com/carabiner-dev/command/keys"

keyOpts := &keys.Options{}

verifyCmd := &cobra.Command{
    Use: "verify",
    RunE: func(cmd *cobra.Command, args []string) error {
        providers, err := keyOpts.ParseKeys()
        if err != nil {
            return err
        }
        // Use providers for verification...
        return nil
    },
}

keyOpts.AddFlags(verifyCmd)

output - Output File Management

Package: github.com/carabiner-dev/command/output

Provides output file path configuration with --output/-o flag. Returns an io.Writer that writes to the specified file or defaults to STDOUT.

Usage:

import "github.com/carabiner-dev/command/output"

outOpts := &output.Options{}

exportCmd := &cobra.Command{
    Use: "export",
    RunE: func(cmd *cobra.Command, args []string) error {
        writer, err := outOpts.GetWriter()
        if err != nil {
            return err
        }
        // Write output to file or STDOUT...
        fmt.Fprintln(writer, "data")
        return nil
    },
}

outOpts.AddFlags(exportCmd)

Contributing

This goal of this package is to to keep reusable sets of flags that have a high reuse incidence. We try to keep the dependency tree as small as possible. It is expected to mature slowly.

Feel free to file issues or suggestions if you find it useful.

This software is released under the Apache-2.0 license, paches are also welcome.

Documentation

Index

• type FlagConfig
• type KeyOptions
  • func (ko *KeyOptions) AddFlags(cmd *cobra.Command)
  • func (ko *KeyOptions) Config() *OptionsSetConfig
  • func (ko *KeyOptions) ParseKeys() ([]key.PublicKeyProvider, error)
  • func (ko *KeyOptions) Validate() error
• type OptionsSet
• type OptionsSetConfig
  • func (c *OptionsSetConfig) HelpText(id string) string
  • func (c *OptionsSetConfig) LongFlag(id string) string
  • func (c *OptionsSetConfig) ShortFlag(id string) string
• type OutputFile
  • func (oo *OutputFile) AddFlags(cmd *cobra.Command)
  • func (oo *OutputFile) Config() *OptionsSetConfig
  • func (oo *OutputFile) GetWriter() (io.Writer, error)
  • func (oo *OutputFile) Validate() error

Types

type FlagConfig

type FlagConfig struct {
	Short string
	Long  string
	Help  string
}

FlagConfig holds the configuration of a flag

type KeyOptions

type KeyOptions struct {
	PublicKeyPaths []string
	// contains filtered or unexported fields
}

KeyOptions provides key file configuration for Carabiner applications.

Deprecated: Use github.com/carabiner-dev/command/keys.Options instead.

func (*KeyOptions) AddFlags

func (ko *KeyOptions) AddFlags(cmd *cobra.Command)

AddFlags adds the options flags to a command.

Deprecated: Use github.com/carabiner-dev/command/keys.Options instead.

func (*KeyOptions) Config

func (ko *KeyOptions) Config() *OptionsSetConfig

Config returns the flag configuration for key options.

Deprecated: Use github.com/carabiner-dev/command/keys.Options instead.

func (*KeyOptions) ParseKeys

func (ko *KeyOptions) ParseKeys() ([]key.PublicKeyProvider, error)

ParseKeys parses the key files and returns a slice of public key providers.

Deprecated: Use github.com/carabiner-dev/command/keys.Options instead.

func (*KeyOptions) Validate

func (ko *KeyOptions) Validate() error

Validate checks the options. Key files are verified to check if they exist.

Deprecated: Use github.com/carabiner-dev/command/keys.Options instead.

type OptionsSet

type OptionsSet interface {
	AddFlags(*cobra.Command)
	Validate() error
	Config() *OptionsSetConfig
}

OptionsSet is an interface that defines the functions options set need to implement to make them reusable.

type OptionsSetConfig

type OptionsSetConfig struct {
	FlagPrefix string
	Flags      map[string]FlagConfig
}

OptionsSetConfig configures a flag

func (*OptionsSetConfig) HelpText

func (c *OptionsSetConfig) HelpText(id string) string

func (*OptionsSetConfig) LongFlag

func (c *OptionsSetConfig) LongFlag(id string) string

func (*OptionsSetConfig) ShortFlag

func (c *OptionsSetConfig) ShortFlag(id string) string

type OutputFile

type OutputFile struct {
	OutputPath string
	// contains filtered or unexported fields
}

OutputFile provides output file configuration for Carabiner applications.

Deprecated: Use github.com/carabiner-dev/command/output.Options instead.

func (*OutputFile) AddFlags

func (oo *OutputFile) AddFlags(cmd *cobra.Command)

AddFlags adds the options flags to a command.

Deprecated: Use github.com/carabiner-dev/command/output.Options instead.

func (*OutputFile) Config

func (oo *OutputFile) Config() *OptionsSetConfig

Config returns the flag configuration for output options.

Deprecated: Use github.com/carabiner-dev/command/output.Options instead.

func (*OutputFile) GetWriter

func (oo *OutputFile) GetWriter() (io.Writer, error)

GetWriter returns a writer for the output.

Deprecated: Use github.com/carabiner-dev/command/output.Options instead.

func (*OutputFile) Validate

func (oo *OutputFile) Validate() error

Validate checks the output options.

Deprecated: Use github.com/carabiner-dev/command/output.Options instead.