cmd

Documentation

Overview

Package cmd implements the CLI commands using Cobra.

Global variables are used for flag binding (a Cobra convention), but runtime state is passed through CommandContext via Cobra's context mechanism. This enables isolated testing and cleaner dependency injection.

Index

• func Execute() error
• func ExitCode(executionError error) int
• func IsQuietIntent() bool
• func ResetQuietIntentForTests()
• func SetQuietIntent(v bool)
• func SetVersionInfo(v, c, d string)
• func WithCommandContext(ctx context.Context, cmdCtx *CommandContext) context.Context
• type CommandContext
  • func GetCommandContext(ctx context.Context) *CommandContext
  • func NewCommandContext() *CommandContext
• type CommandFlags

Functions

func Execute

func Execute() error

Execute adds all child commands to the root command and sets flags appropriately.

func ExitCode

func ExitCode(executionError error) int

ExitCode maps execution errors to process exit codes.

func IsQuietIntent

func IsQuietIntent() bool

IsQuietIntent reports whether quiet mode was requested via CLI flags.

func ResetQuietIntentForTests

func ResetQuietIntentForTests()

ResetQuietIntentForTests resets the quiet-intent flag for test isolation.

func SetQuietIntent

func SetQuietIntent(v bool)

SetQuietIntent records that quiet mode was requested.

func SetVersionInfo

func SetVersionInfo(v, c, d string)

SetVersionInfo sets version information from main

func WithCommandContext

func WithCommandContext(ctx context.Context, cmdCtx *CommandContext) context.Context

WithCommandContext returns a new context with the CommandContext stored in it.

Types

type CommandContext

type CommandContext struct {
	// Runtime state (set during PersistentPreRunE)
	Config  *config.Config
	Manager *container.Manager

	// Flags - these are populated from the global flag variables after parsing.
	// While Cobra requires global variables for flag binding, we copy values
	// here for cleaner access and to enable test isolation.
	Flags CommandFlags
}

CommandContext holds all state for command execution.

Usage in commands:

RunE: func(cmd *cobra.Command, args []string) error {
    cmdCtx := GetCommandContext(cmd.Context())
    return cmdCtx.Manager.SomeMethod()
}

This replaces global variables to enable: - Concurrent command testing - Isolated unit tests - Clean test state - Dependency injection

func GetCommandContext

func GetCommandContext(ctx context.Context) *CommandContext

GetCommandContext retrieves the CommandContext from a context. Returns nil if no CommandContext is stored.

func NewCommandContext

func NewCommandContext() *CommandContext

NewCommandContext creates a fresh CommandContext for testing or execution.

type CommandFlags

type CommandFlags struct {
	CfgFile   string
	Memory    string
	CPUs      int
	Name      string
	Packages  string
	CfInclude string
}

CommandFlags holds all flag values for commands. These are copied from the global flag variables during initialization.