root

Documentation

Overview

Root command boone starts the UI and begins monitoring configured paths.

Usage:

boone --config /path/to/config

Index

• func NewCommand() *cobra.Command
• type Handler
  • func (l *Handler) BindFlags(cmd *cobra.Command) []string
  • func (h *Handler) Init() handler_cobra.Init
  • func (h *Handler) Run(ctx context.Context, input handler.Input)

Functions

func NewCommand

func NewCommand() *cobra.Command

New returns a cobra command instance based on Handler.

Types

type Handler

type Handler struct {
	handler.Session

	ConfigPath string

	Log *log_zap.Mixin
}

Handler defines the sub-command flags and logic.

func (*Handler) BindFlags

func (l *Handler) BindFlags(cmd *cobra.Command) []string

BindFlags binds the flags to Handler fields.

It implements cli/handler/cobra.Handler.

func (*Handler) Init

func (h *Handler) Init() handler_cobra.Init

Init defines the command, its environment variable prefix, etc.

It implements cli/handler/cobra.Handler.

func (*Handler) Run

func (h *Handler) Run(ctx context.Context, input handler.Input)

Run performs the sub-command logic.

It implements cli/handler/cobra.Handler.