cli

Documentation

Index

• func GetLogger(cmd *cli.Command) *zap.Logger
• func InitializeLogging(ctx context.Context, cmd *cli.Command) (context.Context, error)
• func NewApplyCommand() *cli.Command
• func NewInitCommand() *cli.Command
• func SetupCliV3Commands(commands []*cli.Command, ctx *Context)
• type Context
  • func GetSharedContext(cmd *cli.Command) *Context

Functions

func GetLogger

func GetLogger(cmd *cli.Command) *zap.Logger

GetLogger retrieves the logger directly from command metadata

func InitializeLogging

func InitializeLogging(ctx context.Context, cmd *cli.Command) (context.Context, error)

InitializeLogging sets up logging based on command-line flags and environment variables. This function is designed to be used as the Before hook in urfave/cli applications. Behavior: - --debug acts as shorthand for --log-level=debug and --verbose (forces console + verbose) - --log-level debug without --verbose sets level internally but does not enable console unless explicitly requested elsewhere

func NewApplyCommand

func NewApplyCommand() *cli.Command

NewApplyCommand returns the 'apply' command for urfave/cli.

func NewInitCommand

func NewInitCommand() *cli.Command

NewInitCommand returns the 'init' command for urfave/cli. It initializes the default agent-sync project structure.

func SetupCliV3Commands

func SetupCliV3Commands(commands []*cli.Command, ctx *Context)

SetupCliV3Commands registers all commands for the urfave/cli/v3 version and sets up the context in each command's metadata.

Types

type Context

type Context struct {
	// Logger is used for internal logging (debug, error tracking)
	Logger *zap.Logger

	// Output is used for user-facing console output
	Output log.OutputWriter

	// Debug indicates whether debug shorthand was requested.
	// When true, logging should be forced to debug level and console verbose enabled.
	Debug bool
}

Context holds shared resources and configuration for CLI commands. It provides consistent access to logging and output facilities.

func GetSharedContext

func GetSharedContext(cmd *cli.Command) *Context

GetSharedContext retrieves the shared context from command metadata