feat: Integrate viper for configuration default flags across commands and enhance logging and enrichment features

Author: wiebe-vandendriessche

cmd/enrich.go

@@ -21,20 +21,20 @@ var enrichCmd = &cobra.Command{
 or by loading values from a configuration file. Optionally refetch model metadata
 from Hugging Face API and README before enrichment.`,
 	RunE: func(cmd *cobra.Command, args []string) error {
-		// Validate strategy
-		strategy := strings.ToLower(strings.TrimSpace(enrichStrategy))
+		// Get strategy from viper (respects config file)
+		strategy := strings.ToLower(strings.TrimSpace(viper.GetString("enrich.strategy")))
 		if strategy == "" {
 			strategy = "interactive"
 		}
 		switch strategy {
 		case "interactive", "file":
 			// ok
 		default:
-			return fmt.Errorf("invalid --strategy %q (expected interactive|file)", enrichStrategy)
+			return fmt.Errorf("invalid strategy %q (expected interactive|file)", strategy)
 		}
 
-		// Validate log level
-		level := strings.ToLower(strings.TrimSpace(enrichLogLevel))
+		// Get log level from viper
+		level := strings.ToLower(strings.TrimSpace(viper.GetString("log.level")))
 		if level == "" {
 			level = "standard"
 		}
@@ -68,31 +68,35 @@ from Hugging Face API and README before enrichment.`,
 			outPath = enrichInput // overwrite by default
 		}
 
-		// Determine spec version (default to same version as input)
-		// Note: if not specified, WriteBOM will use the BOM's existing spec version
-		specVersion := strings.TrimSpace(enrichSpecVersion)
+		// Get settings from viper (respects config file)
+		specVersion := strings.TrimSpace(viper.GetString("output.specVersion"))
+		outputFormat := viper.GetString("output.format")
+		if outputFormat == "" {
+			outputFormat = "auto"
+		}
 
 		// Build enricher configuration
 		cfg := enricher.Config{
 			Strategy:     strategy,
-			ConfigFile:   enrichConfigFile,
-			RequiredOnly: enrichRequiredOnly,
-			MinWeight:    enrichMinWeight,
-			Refetch:      enrichRefetch,
-			NoPreview:    enrichNoPreview,
+			ConfigFile:   viper.GetString("enrich.configFile"),
+			RequiredOnly: viper.GetBool("enrich.requiredOnly"),
+			MinWeight:    viper.GetFloat64("enrich.minWeight"),
+			Refetch:      viper.GetBool("enrich.refetch"),
+			NoPreview:    viper.GetBool("enrich.noPreview"),
 			SpecVersion:  specVersion,
-			HFToken:      enrichHFToken,
-			HFBaseURL:    enrichHFBaseURL,
-			HFTimeout:    enrichHFTimeout,
+			HFToken:      viper.GetString("huggingface.token"),
+			HFBaseURL:    viper.GetString("huggingface.baseURL"),
+			HFTimeout:    viper.GetInt("huggingface.timeout"),
 		}
 
 		// Load config file values if using file strategy
 		var configViper *viper.Viper
 		if strategy == "file" {
-			if enrichConfigFile == "" {
-				return fmt.Errorf("--file is required when using --strategy file")
+			configFile := cfg.ConfigFile
+			if configFile == "" {
+				configFile = "./config/enrichment.yaml"
 			}
-			configViper, err = loadEnrichmentConfig(enrichConfigFile)
+			configViper, err = loadEnrichmentConfig(configFile)
 			if err != nil {
 				return fmt.Errorf("failed to load config file: %w", err)
 			}
@@ -112,7 +116,7 @@ from Hugging Face API and README before enrichment.`,
 		}
 
 		// Write output
-		if err := bomio.WriteBOM(enriched, outPath, enrichOutputFormat, specVersion); err != nil {
+		if err := bomio.WriteBOM(enriched, outPath, outputFormat, specVersion); err != nil {
 			return fmt.Errorf("failed to write output: %w", err)
 		}
 
@@ -162,6 +166,20 @@ func init() {
 	enrichCmd.Flags().IntVar(&enrichHFTimeout, "hf-timeout", 30, "Hugging Face API timeout in seconds (for refetch)")
 
 	_ = enrichCmd.MarkFlagRequired("input")
+
+	// Bind flags to viper for config file support
+	viper.BindPFlag("enrich.strategy", enrichCmd.Flags().Lookup("strategy"))
+	viper.BindPFlag("enrich.configFile", enrichCmd.Flags().Lookup("file"))
+	viper.BindPFlag("enrich.requiredOnly", enrichCmd.Flags().Lookup("required-only"))
+	viper.BindPFlag("enrich.minWeight", enrichCmd.Flags().Lookup("min-weight"))
+	viper.BindPFlag("enrich.refetch", enrichCmd.Flags().Lookup("refetch"))
+	viper.BindPFlag("enrich.noPreview", enrichCmd.Flags().Lookup("no-preview"))
+	viper.BindPFlag("log.level", enrichCmd.Flags().Lookup("log-level"))
+	viper.BindPFlag("huggingface.token", enrichCmd.Flags().Lookup("hf-token"))
+	viper.BindPFlag("huggingface.baseURL", enrichCmd.Flags().Lookup("hf-base-url"))
+	viper.BindPFlag("huggingface.timeout", enrichCmd.Flags().Lookup("hf-timeout"))
+	viper.BindPFlag("output.format", enrichCmd.Flags().Lookup("output-format"))
+	viper.BindPFlag("output.specVersion", enrichCmd.Flags().Lookup("spec"))
 }
 
 // loadEnrichmentConfig loads enrichment values from a YAML config file

cmd/generate.go

@@ -9,6 +9,7 @@ import (
 
 	cdx "github.com/CycloneDX/cyclonedx-go"
 	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
 
 	"github.com/idlab-discover/AIBoMGen-cli/internal/builder"
 	"github.com/idlab-discover/AIBoMGen-cli/internal/fetcher"
@@ -50,20 +51,20 @@ var generateCmd = &cobra.Command{
 			return err
 		}
 
-		// Resolve effective log level.
-		level := strings.ToLower(strings.TrimSpace(generateLogLevel))
+		// Resolve effective log level (from config, env, or flag).
+		level := strings.ToLower(strings.TrimSpace(viper.GetString("log.level")))
 		if level == "" {
 			level = "standard"
 		}
 		switch level {
 		case "quiet", "standard", "debug":
 			// ok
 		default:
-			return fmt.Errorf("invalid --log-level %q (expected quiet|standard|debug)", generateLogLevel)
+			return fmt.Errorf("invalid --log-level %q (expected quiet|standard|debug)", level)
 		}
 
-		// Resolve effective HF mode.
-		mode := strings.ToLower(strings.TrimSpace(hfMode))
+		// Resolve effective HF mode (from config, env, or flag).
+		mode := strings.ToLower(strings.TrimSpace(viper.GetString("huggingface.mode")))
 		if mode == "" {
 			mode = "online"
 		}
@@ -73,10 +74,19 @@ var generateCmd = &cobra.Command{
 		default:
 			return fmt.Errorf("invalid --hf-mode %q (expected online|dummy)", hfMode)
 		}
+		// Get format from viper (respects config file)
+		outputFormat := viper.GetString("output.format")
+		if outputFormat == "" {
+			outputFormat = "auto"
+		}
+
+		// Get spec version from viper
+		specVersion := viper.GetString("output.specVersion")
+
 		// Fail fast on explicit format/extension mismatch before scanning
-		if generateOutput != "" && generateOutputFormat != "" && generateOutputFormat != "auto" {
+		if generateOutput != "" && outputFormat != "" && outputFormat != "auto" {
 			ext := filepath.Ext(generateOutput)
-			if generateOutputFormat == "xml" && ext == ".json" {
+			if outputFormat == "xml" && ext == ".json" {
 				return fmt.Errorf("output path extension %q does not match format %q", ext, generateOutputFormat)
 			}
 			if generateOutputFormat == "json" && ext == ".xml" {
@@ -102,10 +112,13 @@ var generateCmd = &cobra.Command{
 			return err
 		}
 
-		if hfTimeoutSec <= 0 {
-			hfTimeoutSec = 10
+		// Get HF settings from viper
+		hfToken := viper.GetString("huggingface.token")
+		hfTimeout := viper.GetInt("huggingface.timeout")
+		if hfTimeout <= 0 {
+			hfTimeout = 10
 		}
-		timeout := time.Duration(hfTimeoutSec) * time.Second
+		timeout := time.Duration(hfTimeout) * time.Second
 
 		var discoveredBOMs []generator.DiscoveredBOM
 		if mode == "dummy" {
@@ -140,7 +153,7 @@ var generateCmd = &cobra.Command{
 			}
 		}
 
-		fmtChosen := generateOutputFormat
+		fmtChosen := outputFormat
 		if fmtChosen == "auto" || fmtChosen == "" {
 			ext := filepath.Ext(output)
 			if ext == ".xml" {
@@ -182,7 +195,7 @@ var generateCmd = &cobra.Command{
 			fileName := fmt.Sprintf("%s_aibom%s", sanitized, fileExt)
 			dest := filepath.Join(outputDir, fileName)
 
-			if err := bomio.WriteBOM(d.BOM, dest, fmtChosen, generateSpecVersion); err != nil {
+			if err := bomio.WriteBOM(d.BOM, dest, fmtChosen, specVersion); err != nil {
 				return err
 			}
 			written = append(written, dest)
@@ -209,6 +222,14 @@ func init() {
 	generateCmd.Flags().StringVar(&hfToken, "hf-token", "", "Hugging Face access token (string)")
 	generateCmd.Flags().BoolVar(&enrich, "enrich", false, "Prompt for missing fields and compute completeness")
 	generateCmd.Flags().StringVar(&generateLogLevel, "log-level", "standard", "Log level: quiet|standard|debug (default: standard)")
+
+	// Bind flags to viper for config file support
+	viper.BindPFlag("output.format", generateCmd.Flags().Lookup("format"))
+	viper.BindPFlag("output.specVersion", generateCmd.Flags().Lookup("spec"))
+	viper.BindPFlag("huggingface.mode", generateCmd.Flags().Lookup("hf-mode"))
+	viper.BindPFlag("huggingface.timeout", generateCmd.Flags().Lookup("hf-timeout"))
+	viper.BindPFlag("huggingface.token", generateCmd.Flags().Lookup("hf-token"))
+	viper.BindPFlag("log.level", generateCmd.Flags().Lookup("log-level"))
 }
 
 func bomMetadataComponentName(bom *cdx.BOM) string {

cmd/root.go

@@ -4,6 +4,7 @@ import (
 	"errors"
 	"fmt"
 	"os"
+	"strings"
 
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
@@ -67,12 +68,20 @@ func initConfig() {
 		home, err := os.UserHomeDir()
 		cobra.CheckErr(err)
 
-		// Search config in home directory with name ".cobra" (without extension).
+		// Search for config in multiple locations (in order of priority):
+		// 1. $HOME/.aibomgen-cli.yaml
+		// 2. ./config/config.yaml (project local)
 		viper.AddConfigPath(home)
+		viper.AddConfigPath("./config")
 		viper.SetConfigType("yaml")
-		viper.SetConfigName(".cobra")
+		viper.SetConfigName(".aibomgen-cli") // for $HOME/.aibomgen-cli.yaml
+		viper.SetConfigName("config")        // for ./config/config.yaml
 	}
 
+	// Enable environment variable support (e.g., AIBOMGEN_HUGGINGFACE_TOKEN)
+	// Replace dots with underscores: huggingface.token -> AIBOMGEN_HUGGINGFACE_TOKEN
+	viper.SetEnvPrefix("AIBOMGEN")
+	viper.SetEnvKeyReplacer(strings.NewReplacer(".", "_"))
 	viper.AutomaticEnv()
 
 	err := viper.ReadInConfig()

cmd/validate.go

@@ -9,6 +9,7 @@ import (
 	"github.com/idlab-discover/AIBoMGen-cli/internal/metadata"
 	"github.com/idlab-discover/AIBoMGen-cli/internal/validator"
 	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
 )
 
 var (
@@ -29,16 +30,16 @@ var validateCmd = &cobra.Command{
 			return fmt.Errorf("--input is required")
 		}
 
-		// Resolve effective log level.
-		level := strings.ToLower(strings.TrimSpace(validateLogLevel))
+		// Get log level from viper (respects config file)
+		level := strings.ToLower(strings.TrimSpace(viper.GetString("log.level")))
 		if level == "" {
 			level = "standard"
 		}
 		switch level {
 		case "quiet", "standard", "debug":
 			// ok
 		default:
-			return fmt.Errorf("invalid --log-level %q (expected quiet|standard|debug)", validateLogLevel)
+			return fmt.Errorf("invalid --log-level %q (expected quiet|standard|debug)", level)
 		}
 
 		// Wire internal package logging based on log level.
@@ -84,4 +85,10 @@ func init() {
 	validateCmd.Flags().StringVar(&validateLogLevel, "log-level", "standard", "Log level: quiet|standard|debug (default: standard)")
 
 	validateCmd.MarkFlagRequired("input")
+
+	// Bind flags to viper for config file support
+	viper.BindPFlag("validate.strict", validateCmd.Flags().Lookup("strict"))
+	viper.BindPFlag("validate.minScore", validateCmd.Flags().Lookup("min-score"))
+	viper.BindPFlag("validate.checkModelCard", validateCmd.Flags().Lookup("check-model-card"))
+	viper.BindPFlag("log.level", validateCmd.Flags().Lookup("log-level"))
 }

config/config.yaml

@@ -0,0 +1,81 @@
+# AIBoMGen-cli Global Configuration
+# This file provides default values for common settings across all commands.
+# Values can be overridden by command-line flags or by using --config to specify a different file.
+# Default location: $HOME/.aibomgen-cli.yaml or ./config/config.yaml
+
+# ============================================================================
+# Hugging Face API Settings
+# ============================================================================
+huggingface:
+  # API token for authenticated requests (optional)
+  # You can get a token from https://huggingface.co/settings/tokens
+  token: ""
+  
+  # Base URL for Hugging Face API (change only if using a private mirror)
+  baseURL: "https://huggingface.co"
+  
+  # API timeout in seconds
+  timeout: 10
+  
+  # Metadata fetching mode for generate command
+  # Options: online (fetch from API), dummy (use mock data)
+  mode: "online"
+
+# ============================================================================
+# Output Settings
+# ============================================================================
+output:
+  # Default output format for generated BOMs
+  # Options: json, xml, auto
+  format: "json"
+  
+  # CycloneDX specification version
+  # Options: 1.4, 1.5, 1.6 (empty = use latest)
+  specVersion: ""
+  
+  # Default output directory for generated BOMs
+  directory: "./dist"
+
+# ============================================================================
+# Logging Settings
+# ============================================================================
+log:
+  # Log verbosity level
+  # Options: quiet, standard, debug
+  level: "standard"
+
+# ============================================================================
+# Enrichment Settings
+# ============================================================================
+enrich:
+  # Default enrichment strategy
+  # Options: interactive (prompt for values), file (load from config)
+  strategy: "interactive"
+  
+  # Path to enrichment configuration file
+  configFile: "./config/enrichment.yaml"
+  
+  # Only enrich required fields
+  requiredOnly: false
+  
+  # Minimum field weight threshold (0.0 to 1.0)
+  minWeight: 0.0
+  
+  # Refetch metadata from Hugging Face before enrichment
+  refetch: true
+  
+  # Skip preview before saving changes
+  noPreview: false
+
+# ============================================================================
+# Validation Settings
+# ============================================================================
+validate:
+  # Strict validation mode (enforce all required fields)
+  strict: false
+  
+  # Minimum completeness score (0.0 to 1.0)
+  minScore: 0.0
+  
+  # Check model card fields
+  checkModelCard: true