restore

Signed-off-by: Harper, Jason M <[email protected]>

Author: harp-intel

README.md

@@ -129,6 +129,38 @@ $ ./perfspect config --cores 24 --llc 2.0 --uncore-max 1.8
 ...
 </pre>
 
+##### Recording Configuration
+Before making changes, you can record the current configuration to a file using the `--record` flag. This creates a human-readable configuration file that can be used to restore settings later.
+
+Example:
+<pre>
+$ ./perfspect config --record
+Configuration recorded to: perfspect_2025-12-01_14-30-45/gnr_config.txt
+</pre>
+
+##### Restoring Configuration
+The `config restore` subcommand restores configuration from a previously recorded file. This is useful for reverting changes or applying a known-good configuration across multiple systems.
+
+Example:
+<pre>
+$ ./perfspect config restore perfspect_2025-12-01_14-30-45/gnr_config.txt
+Configuration settings to restore from perfspect_2025-12-01_14-30-45/gnr_config.txt:
+  --cores 86
+  --llc 2.4
+  --uncore-max-compute 2.2
+  ...
+Apply these settings? (yes/no): yes
+...
+</pre>
+
+Use the `--yes` flag to skip the confirmation prompt:
+<pre>
+$ ./perfspect config restore perfspect_2025-12-01_14-30-45/gnr_config.txt --yes
+</pre>
+
+> [!TIP]
+> The restore command works with remote targets too. Use `--target` or `--targets` to restore configuration on remote systems.
+
 ### Common Command Options
 
 #### Local vs. Remote Targets

cmd/config/config.go

@@ -26,6 +26,8 @@ const cmdName = "config"
 var examples = []string{
 	fmt.Sprintf("  Set core count on local host:            $ %s %s --cores 32", common.AppName, cmdName),
 	fmt.Sprintf("  Set multiple config items on local host: $ %s %s --core-max 3.0 --uncore-max 2.1 --tdp 120", common.AppName, cmdName),
+	fmt.Sprintf("  Record current config to file:           $ %s %s --record", common.AppName, cmdName),
+	fmt.Sprintf("  Restore config from file:                $ %s %s restore gnr_config.txt", common.AppName, cmdName),
 	fmt.Sprintf("  Set core count on remote target:         $ %s %s --cores 32 --target 192.168.1.1 --user fred --key fred_key", common.AppName, cmdName),
 	fmt.Sprintf("  View current config on remote target:    $ %s %s --target 192.168.1.1 --user fred --key fred_key", common.AppName, cmdName),
 	fmt.Sprintf("  Set governor on remote targets:          $ %s %s --gov performance --targets targets.yaml", common.AppName, cmdName),
@@ -367,7 +369,7 @@ func printConfig(reports map[string][]byte, toStdout bool, toFile bool, outputDi
 			fmt.Print(string(reportBytes))
 		}
 		if toFile {
-			outputFilePath := fmt.Sprintf("%s/config_%s.txt", outputDir, targetName)
+			outputFilePath := fmt.Sprintf("%s/%s_config.txt", outputDir, targetName)
 			err := os.WriteFile(outputFilePath, reportBytes, 0644) // #nosec G306
 			if err != nil {
 				err = fmt.Errorf("failed to write configuration report to file: %v", err)

cmd/config/flag_groups.go

@@ -67,7 +67,6 @@ const (
 const (
 	flagNoSummaryName = "no-summary"
 	flagRecordName    = "record"
-	flagRestoreName   = "restore"
 )
 
 // governorOptions - list of valid governor options
@@ -242,9 +241,6 @@ func initializeFlags(cmd *cobra.Command) {
 	group.flags = append(group.flags,
 		newBoolFlag(cmd, flagRecordName, false, nil, "record the current configuration to a file to be restored later", "", nil),
 	)
-	group.flags = append(group.flags,
-		newStringFlag(cmd, flagRestoreName, "", nil, "restore a previously recorded configuration from the specified file", "", nil),
-	)
 	flagGroups = append(flagGroups, group)
 
 	common.AddTargetFlags(Cmd)
@@ -269,6 +265,11 @@ func usageFunc(cmd *cobra.Command) error {
 		cmd.Printf("    --%-20s %s\n", flag.Name, flag.Help)
 	}
 
+	cmd.Printf("\nSubcommands:\n")
+	for _, subCmd := range cmd.Commands() {
+		cmd.Printf("  %s: %s\n", subCmd.Name(), subCmd.Short)
+	}
+
 	cmd.Println("\nGlobal Flags:")
 	cmd.Parent().PersistentFlags().VisitAll(func(pf *pflag.Flag) {
 		flagDefault := ""