Update docs

.changes/unreleased/Added-20250409-174528.yaml

@@ -0,0 +1,3 @@
+kind: Added
+body: 'feat: Package operation `versionCheck` supports regular expressions (see [regexp](https://pkg.go.dev/regexp) package for docs)'
+time: 2025-04-09T17:45:28.836497149-05:00

.changes/unreleased/Added-20250501-110745.yaml

@@ -0,0 +1,3 @@
+kind: Added
+body: 'Command lists: added `cmdLists.[name].notify` object'
+time: 2025-05-01T11:07:45.96164753-05:00

.changes/unreleased/Added-20250704-085917.yaml

@@ -0,0 +1,3 @@
+kind: Added
+body: Testing setup with Docker
+time: 2025-07-04T08:59:17.430373451-05:00

.changes/unreleased/Added-20250704-102126.yaml

@@ -0,0 +1,3 @@
+kind: Added
+body: 'CLI: add global flag --hostsConfig that allows hosts to be dynamic in relation to the main config'
+time: 2025-07-04T10:21:26.864635558-05:00

.changes/unreleased/Added-20250715-202303.yaml

@@ -0,0 +1,3 @@
+kind: Added
+body: 'CLI: Exec subcommand `hosts`. See documentation for more details.'
+time: 2025-07-15T20:23:03.647128713-05:00

.changes/unreleased/Added-20250723-220340.yaml

@@ -0,0 +1,3 @@
+kind: Added
+body: 'CLI: added `exec hosts` subcommand `list`'
+time: 2025-07-23T22:03:40.24191927-05:00

.changes/unreleased/Changed-20250321-090849.yaml

@@ -0,0 +1,3 @@
+kind: Changed
+body: 'Commands: `host` can now be `localhost` or `127.0.0.1` to run commands locally'
+time: 2025-03-21T09:08:49.871021144-05:00

.changes/unreleased/Changed-20250325-003357.yaml

@@ -0,0 +1,3 @@
+kind: Changed
+body: lists loaded from external files only if no list config present in current file
+time: 2025-03-25T00:33:57.039431409-05:00

.changes/unreleased/Changed-20250407-223020.yaml

@@ -0,0 +1,3 @@
+kind: Changed
+body: "`PackageManager.Parse` renamed to `ParseRemotePackageManagerVersionOutput`. This now returns arrays of PackageManagerCommon.Package and errors."
+time: 2025-04-07T22:30:20.342177323-05:00

.changes/unreleased/Changed-20250418-133440.yaml

@@ -0,0 +1,3 @@
+kind: Changed
+body: 'Internal: refactoring and renaming functions'
+time: 2025-04-18T13:34:40.842541658-05:00

.changes/unreleased/Changed-20250501-110534.yaml

@@ -0,0 +1,3 @@
+kind: Changed
+body: 'Commands: moved output-prefixed keys to the `commands.[name].output` object'
+time: 2025-05-01T11:05:34.90130087-05:00

.changes/unreleased/Changed-20250609-072601.yaml

@@ -0,0 +1,3 @@
+kind: Changed
+body: Change internal method name for better understanding
+time: 2025-06-09T07:26:01.819927627-05:00

.changes/unreleased/Changed-20250709-231919.yaml

@@ -0,0 +1,3 @@
+kind: Changed
+body: Improved error message for remote version package output
+time: 2025-07-09T23:19:19.431960446-05:00

.changes/unreleased/Fixed-20250418-095747.yaml

@@ -0,0 +1,3 @@
+kind: Fixed
+body: 'Command Lists: hooks now run correctly when commands finish'
+time: 2025-04-18T09:57:47.39035092-05:00

.changes/unreleased/Fixed-20250424-225711.yaml

@@ -0,0 +1,3 @@
+kind: Fixed
+body: Log file passed using `--log-file` correctly used
+time: 2025-04-24T22:57:11.592829277-05:00

.changes/unreleased/Fixed-20251115-173206.yaml

@@ -0,0 +1,3 @@
+kind: Fixed
+body: Cmd Type `script` now correctly appends arguments
+time: 2025-11-15T17:32:06.86128885-06:00

.gitignore

@@ -5,6 +5,6 @@ dist/
 .codegpt
 
 *.log
-*.sh
+/*.sh
 /*.yaml
 /*.yml

.vscode/settings.json

@@ -9,5 +9,6 @@
         "mautrix",
         "nikoksr",
         "Strs"
-    ]
+    ],
+    "CodeGPT.apiKey": "CodeGPT Plus Beta"
 }

backy.code-workspace

@@ -18,6 +18,7 @@
 			"maunium",
 			"mautrix",
 			"nikoksr",
+			"packagemanagercommon",
 			"rawbytes",
 			"remotefetcher",
 			"Strs"

cmd/backup.go

@@ -30,9 +30,14 @@ func init() {
 }
 
 func Backup(cmd *cobra.Command, args []string) {
-	backyConfOpts := backy.NewOpts(cfgFile, backy.AddCommandLists(cmdLists), backy.SetLogFile(logFile), backy.SetCmdStdOut(cmdStdOut))
+	backyConfOpts := backy.NewConfigOptions(configFile,
+		backy.AddCommandLists(cmdLists),
+		backy.SetLogFile(logFile),
+		backy.EnableCommandStdOut(cmdStdOut),
+		backy.SetHostsConfigFile(hostsConfigFile))
+
 	backyConfOpts.InitConfig()
-	backyConfOpts.ReadConfig()
+	backyConfOpts.ParseConfigurationFile()
 
 	backyConfOpts.RunListConfig("")
 	for _, host := range backyConfOpts.Hosts {

cmd/backup_test.go

@@ -0,0 +1,54 @@
+package cmd
+
+// import (
+// 	"bufio"
+// 	"encoding/json"
+// 	"os"
+// 	"os/exec"
+// 	"strings"
+// 	"testing"
+
+// 	"github.com/stretchr/testify/assert"
+// )
+
+// // TestConfigOptions tests the configuration options for the backy package.
+// func Test_ErrorHook(t *testing.T) {
+// 	configFile := "-f ../../tests/ErrorHook.yml"
+// 	logFile := "--log-file=ErrorHook.log"
+// 	backyCommand := exec.Command("go", "run", "../../backy.go", configFile, logFile, "backup")
+// 	backyCommand.Stderr = os.Stdout
+// 	backyCommand.Stdout = os.Stdout
+// 	err := backyCommand.Run()
+// 	assert.Nil(t, err)
+// 	os.Remove("ErrorHook.log")
+// 	logFileData, logFileErr := os.ReadFile("ErrorHook.log")
+// 	if logFileErr != nil {
+// 		assert.FailNow(t, logFileErr.Error())
+
+// 	}
+// 	var JsonData []map[string]interface{}
+// 	jsonScanner := bufio.NewScanner(strings.NewReader(string(logFileData)))
+
+// 	for jsonScanner.Scan() {
+// 		var jsonDataLine map[string]interface{}
+// 		err = json.Unmarshal(jsonScanner.Bytes(), &jsonDataLine)
+// 		assert.Nil(t, err)
+// 		JsonData = append(JsonData, jsonDataLine)
+// 	}
+// 	for _, v := range JsonData {
+// 		_, ok := v["error"]
+// 		if !ok {
+// 			assert.FailNow(t, "error does not exist\n")
+// 			// return
+// 		}
+// 	}
+// 	// t.Logf("%s", logFileData)
+// 	// t.Logf("%v", JsonData)
+// }
+
+// func TestBackupErrorHook(t *testing.T) {
+// 	logFile = "ErrorHook.log"
+
+// 	configFile = "../tests/ErrorHook.yml"
+
+// }

cmd/config.go

@@ -20,7 +20,7 @@ package cmd
 
 // func config(cmd *cobra.Command, args []string) {
 
-// 	opts := backy.NewOpts(cfgFile, backy.cronEnabled())
+// 	opts := backy.NewConfigOptions(configFile, backy.cronEnabled())
 // 	opts.InitConfig()
 
 // }

cmd/cron.go

@@ -18,13 +18,14 @@ var (
 func cron(cmd *cobra.Command, args []string) {
 	parseS3Config()
 
-	opts := backy.NewOpts(cfgFile,
+	opts := backy.NewConfigOptions(configFile,
 		backy.EnableCron(),
 		backy.SetLogFile(logFile),
-		backy.SetCmdStdOut(cmdStdOut))
+		backy.EnableCommandStdOut(cmdStdOut),
+		backy.SetHostsConfigFile(hostsConfigFile))
 
 	opts.InitConfig()
-	opts.ReadConfig()
+	opts.ParseConfigurationFile()
 
 	opts.Cron()
 }

cmd/exec.go

@@ -21,7 +21,7 @@ var (
 )
 
 func init() {
-	execCmd.AddCommand(hostExecCommand)
+	execCmd.AddCommand(hostExecCommand, hostsExecCommand)
 
 }
 
@@ -32,8 +32,12 @@ func execute(cmd *cobra.Command, args []string) {
 		logging.ExitWithMSG("Please provide a command to run. Pass --help to see options.", 1, nil)
 	}
 
-	opts := backy.NewOpts(cfgFile, backy.AddCommands(args), backy.SetLogFile(logFile), backy.SetCmdStdOut(cmdStdOut))
+	opts := backy.NewConfigOptions(configFile,
+		backy.AddCommands(args),
+		backy.SetLogFile(logFile),
+		backy.EnableCommandStdOut(cmdStdOut),
+		backy.SetHostsConfigFile(hostsConfigFile))
 	opts.InitConfig()
-	opts.ReadConfig()
+	opts.ParseConfigurationFile()
 	opts.ExecuteCmds()
 }

cmd/host.go

@@ -35,10 +35,13 @@ func init() {
 //    2. stdin (on command line) (TODO)
 
 func Host(cmd *cobra.Command, args []string) {
-	backyConfOpts := backy.NewOpts(cfgFile, backy.SetLogFile(logFile), backy.SetCmdStdOut(cmdStdOut))
+	backyConfOpts := backy.NewConfigOptions(configFile,
+		backy.SetLogFile(logFile),
+		backy.EnableCommandStdOut(cmdStdOut),
+		backy.SetHostsConfigFile(hostsConfigFile))
 	backyConfOpts.InitConfig()
 
-	backyConfOpts.ReadConfig()
+	backyConfOpts.ParseConfigurationFile()
 
 	// check CLI input
 	if hostsList == nil {
@@ -46,14 +49,20 @@ func Host(cmd *cobra.Command, args []string) {
 	}
 
 	for _, h := range hostsList {
+		if backy.IsHostLocal(h) {
+			continue
+		}
 		// check if h exists in the config file
 		_, hostFound := backyConfOpts.Hosts[h]
 		if !hostFound {
 			// check if h exists in the SSH config file
-			hostFoundInConfig, s := backy.CheckIfHostHasHostName(h)
+			hostFoundInConfig, s := backy.DoesHostHaveHostName(h)
 			if !hostFoundInConfig {
 				logging.ExitWithMSG("host "+h+" not found", 1, &backyConfOpts.Logger)
 			}
+			if backyConfOpts.Hosts == nil {
+				backyConfOpts.Hosts = make(map[string]*backy.Host)
+			}
 			// create host with hostname and host
 			backyConfOpts.Hosts[h] = &backy.Host{Host: h, HostName: s}
 		}
@@ -68,5 +77,5 @@ func Host(cmd *cobra.Command, args []string) {
 		}
 	}
 
-	backyConfOpts.ExecCmdsSSH(cmdList, hostsList)
+	backyConfOpts.ExecCmdsOnHosts(cmdList, hostsList)
 }

cmd/hosts.go

@@ -0,0 +1,93 @@
+package cmd
+
+import (
+	"maps"
+	"slices"
+
+	"git.andrewnw.xyz/CyberShell/backy/pkg/backy"
+	"git.andrewnw.xyz/CyberShell/backy/pkg/logging"
+	"github.com/spf13/cobra"
+)
+
+var (
+	runCommandsInParallel bool
+
+	hostsExecCommand = &cobra.Command{
+		Use:   "hosts [--command=command1 --command=command2 ... | -c command1 -c command2 ...]",
+		Short: "Runs command defined in config file on the hosts in order specified.",
+		Long:  "Hosts executes specified commands on all the hosts defined in config file.\nUse the --commands or -c flag to choose the commands.",
+		Run:   Hosts,
+	}
+
+	hostsListExecCommand = &cobra.Command{
+		Use:   "list list1 list2 ...",
+		Short: "Runs lists in order specified defined in config file on all hosts.",
+		Long:  "Lists executes specified lists on all the hosts defined in hosts config.\nPass the names of lists as arguments after command.",
+		Run:   HostsList,
+	}
+)
+
+func init() {
+	hostsExecCommand.AddCommand(hostsListExecCommand)
+	hostsListExecCommand.Flags().BoolVarP(&runCommandsInParallel, "parallel", "p", false, "Run commands in parallel on hosts")
+	parseS3Config()
+}
+
+// cli input should be hosts and commands. Hosts are defined in config files.
+// commands can be passed by the following mutually exclusive options:
+//    1. as a list of commands defined in the config file
+//    2. stdin (on command line) (TODO)
+
+func Hosts(cmd *cobra.Command, args []string) {
+	backyConfOpts := backy.NewConfigOptions(configFile,
+		backy.SetLogFile(logFile),
+		backy.EnableCommandStdOut(cmdStdOut),
+		backy.SetHostsConfigFile(hostsConfigFile))
+	backyConfOpts.InitConfig()
+
+	backyConfOpts.ParseConfigurationFile()
+
+	for _, h := range backyConfOpts.Hosts {
+
+		hostsList = append(hostsList, h.Host)
+	}
+
+	if cmdList == nil {
+		logging.ExitWithMSG("error: commands must be specified", 1, &backyConfOpts.Logger)
+	}
+	for _, c := range cmdList {
+		_, cmdFound := backyConfOpts.Cmds[c]
+		if !cmdFound {
+			logging.ExitWithMSG("cmd "+c+" not found", 1, &backyConfOpts.Logger)
+		}
+	}
+
+	backyConfOpts.ExecCmdsOnHosts(cmdList, hostsList)
+}
+
+func HostsList(cmd *cobra.Command, args []string) {
+	backyConfOpts := backy.NewConfigOptions(configFile,
+		backy.SetLogFile(logFile),
+		backy.EnableCommandStdOut(cmdStdOut),
+		backy.SetHostsConfigFile(hostsConfigFile))
+	backyConfOpts.InitConfig()
+
+	backyConfOpts.ParseConfigurationFile()
+
+	if len(args) == 0 {
+		logging.ExitWithMSG("error: no lists specified", 1, &backyConfOpts.Logger)
+	}
+
+	for _, l := range args {
+		_, listFound := backyConfOpts.CmdConfigLists[l]
+		if !listFound {
+			logging.ExitWithMSG("list "+l+" not found", 1, &backyConfOpts.Logger)
+		}
+	}
+
+	maps.DeleteFunc(backyConfOpts.CmdConfigLists, func(k string, v *backy.CmdList) bool {
+		return !slices.Contains(args, k)
+	})
+
+	backyConfOpts.ExecuteListOnHosts(args, runCommandsInParallel)
+}

cmd/list.go

@@ -22,13 +22,13 @@ var (
 		Use:   "cmds [cmd1 cmd2 cmd3...]",
 		Short: "List commands defined in config file.",
 		Long:  "List commands defined in config file",
-		Run:   ListCmds,
+		Run:   ListCommands,
 	}
 	listCmdLists = &cobra.Command{
 		Use:   "lists [list1 list2 ...]",
 		Short: "List lists defined in config file.",
 		Long:  "List lists defined in config file",
-		Run:   ListCmdLists,
+		Run:   ListCommandLists,
 	}
 )
 
@@ -40,7 +40,7 @@ func init() {
 
 }
 
-func ListCmds(cmd *cobra.Command, args []string) {
+func ListCommands(cmd *cobra.Command, args []string) {
 
 	// setup based on whats passed in:
 	//   - cmds
@@ -54,17 +54,19 @@ func ListCmds(cmd *cobra.Command, args []string) {
 
 	parseS3Config()
 
-	opts := backy.NewOpts(cfgFile, backy.SetLogFile(logFile))
+	opts := backy.NewConfigOptions(configFile,
+		backy.SetLogFile(logFile),
+		backy.SetHostsConfigFile(hostsConfigFile))
 
 	opts.InitConfig()
-	opts.ReadConfig()
+	opts.ParseConfigurationFile()
 
 	for _, v := range cmdsToList {
 		opts.ListCommand(v)
 	}
 }
 
-func ListCmdLists(cmd *cobra.Command, args []string) {
+func ListCommandLists(cmd *cobra.Command, args []string) {
 
 	parseS3Config()
 
@@ -74,10 +76,12 @@ func ListCmdLists(cmd *cobra.Command, args []string) {
 		logging.ExitWithMSG("Error: lists subcommand needs lists", 1, nil)
 	}
 
-	opts := backy.NewOpts(cfgFile, backy.SetLogFile(logFile))
+	opts := backy.NewConfigOptions(configFile,
+		backy.SetLogFile(logFile),
+		backy.SetHostsConfigFile(hostsConfigFile))
 
 	opts.InitConfig()
-	opts.ReadConfig()
+	opts.ParseConfigurationFile()
 
 	for _, v := range listsToList {
 		opts.ListCommandList(v)

cmd/root.go

@@ -13,11 +13,12 @@ import (
 
 var (
 	// Used for flags.
-	cfgFile    string
-	verbose    bool
-	cmdStdOut  bool
-	logFile    string
-	s3Endpoint string
+	configFile      string
+	hostsConfigFile string
+	verbose         bool
+	cmdStdOut       bool
+	logFile         string
+	s3Endpoint      string
 
 	rootCmd = &cobra.Command{
 		Use:   "backy",
@@ -35,12 +36,13 @@ func Execute() {
 }
 
 func init() {
-	rootCmd.PersistentFlags().StringVar(&logFile, "log-file", "", "log file to write to")
+	rootCmd.PersistentFlags().StringVar(&logFile, "logFile", "", "log file to write to")
 	rootCmd.PersistentFlags().BoolVar(&cmdStdOut, "cmdStdOut", false, "Pass to print command output to stdout")
 
-	rootCmd.PersistentFlags().StringVarP(&cfgFile, "config", "f", "", "config file to read from")
+	rootCmd.PersistentFlags().StringVarP(&configFile, "config", "f", "", "config file to read from")
+	rootCmd.PersistentFlags().StringVar(&hostsConfigFile, "hostsConfig", "", "yaml hosts file to read from")
 	rootCmd.PersistentFlags().BoolVarP(&verbose, "verbose", "v", false, "Sets verbose level")
-	rootCmd.PersistentFlags().StringVar(&s3Endpoint, "s3-endpoint", "", "Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.")
+	rootCmd.PersistentFlags().StringVar(&s3Endpoint, "s3Endpoint", "", "Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.")
 	rootCmd.AddCommand(backupCmd, execCmd, cronCmd, versionCmd, listCmd)
 }
 

docs/config.yaml

@@ -1,6 +1,7 @@
 baseURL: https://backy.cybershell.xyz/
 languageCode: en-us
 title: A tool for commands
+ignoreLogs: 'warning-partial-superfluous-prefix'
 theme:
   - hugo-theme-relearn
   - plausible-hugo
@@ -13,6 +14,7 @@ module:
   imports:
     - path: github.com/divinerites/plausible-hugo
     - path: github.com/McShelby/hugo-theme-relearn
+      version: "v8.2.0"
 params:
   themeVariant:
     - auto: []

docs/content/cli/_index.md

@@ -26,8 +26,9 @@ Flags:
       --cmdStdOut            Pass to print command output to stdout
   -f, --config string        config file to read from
   -h, --help                 help for backy
-      --log-file string      log file to write to
-      --s3-endpoint string   Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
+      --hostsConfig string   yaml hosts file to read from
+      --logFile string       log file to write to
+      --s3Endpoint string    Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
   -v, --verbose              Sets verbose level
 
 Use "backy [command] --help" for more information about a command.
@@ -51,8 +52,9 @@ Flags:
 Global Flags:
       --cmdStdOut            Pass to print command output to stdout
   -f, --config string        config file to read from
-      --log-file string      log file to write to
-      --s3-endpoint string   Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
+      --hostsConfig string   yaml hosts file to read from
+      --logFile string       log file to write to
+      --s3Endpoint string    Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
   -v, --verbose              Sets verbose level
 ```
 
@@ -70,8 +72,9 @@ Flags:
 Global Flags:
       --cmdStdOut            Pass to print command output to stdout
   -f, --config string        config file to read from
-      --log-file string      log file to write to
-      --s3-endpoint string   Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
+      --hostsConfig string   yaml hosts file to read from
+      --logFile string       log file to write to
+      --s3Endpoint string    Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
   -v, --verbose              Sets verbose level
 ```
 
@@ -86,6 +89,7 @@ Usage:
 
 Available Commands:
   host        Runs command defined in config file on the hosts in order specified.
+  hosts       Runs command defined in config file on the hosts in order specified.
 
 Flags:
   -h, --help   help for exec
@@ -93,8 +97,9 @@ Flags:
 Global Flags:
       --cmdStdOut            Pass to print command output to stdout
   -f, --config string        config file to read from
-      --log-file string      log file to write to
-      --s3-endpoint string   Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
+      --hostsConfig string   yaml hosts file to read from
+      --logFile string       log file to write to
+      --s3Endpoint string    Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
   -v, --verbose              Sets verbose level
 
 Use "backy exec [command] --help" for more information about a command.
@@ -117,8 +122,9 @@ Flags:
 Global Flags:
       --cmdStdOut            Pass to print command output to stdout
   -f, --config string        config file to read from
-      --log-file string      log file to write to
-      --s3-endpoint string   Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
+      --hostsConfig string   yaml hosts file to read from
+      --logFile string       log file to write to
+      --s3Endpoint string    Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
   -v, --verbose              Sets verbose level
 ```
 
@@ -138,8 +144,9 @@ Flags:
 Global Flags:
       --cmdStdOut            Pass to print command output to stdout
   -f, --config string        config file to read from
-      --log-file string      log file to write to
-      --s3-endpoint string   Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
+      --hostsConfig string   yaml hosts file to read from
+      --logFile string       log file to write to
+      --s3Endpoint string    Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
   -v, --verbose              Sets verbose level
 ```
 
@@ -161,8 +168,9 @@ Flags:
 Global Flags:
       --cmdStdOut            Pass to print command output to stdout
   -f, --config string        config file to read from
-      --log-file string      log file to write to
-      --s3-endpoint string   Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
+      --hostsConfig string   yaml hosts file to read from
+      --logFile string       log file to write to
+      --s3Endpoint string    Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
   -v, --verbose              Sets verbose level
 
 Use "backy list [command] --help" for more information about a command.
@@ -181,8 +189,9 @@ Flags:
 Global Flags:
       --cmdStdOut            Pass to print command output to stdout
   -f, --config string        config file to read from
-      --log-file string      log file to write to
-      --s3-endpoint string   Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
+      --hostsConfig string   yaml hosts file to read from
+      --logFile string       log file to write to
+      --s3Endpoint string    Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
   -v, --verbose              Sets verbose level
 ```
 ## list lists
@@ -199,7 +208,8 @@ Flags:
 Global Flags:
       --cmdStdOut            Pass to print command output to stdout
   -f, --config string        config file to read from
-      --log-file string      log file to write to
-      --s3-endpoint string   Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
+      --hostsConfig string   yaml hosts file to read from
+      --logFile string       log file to write to
+      --s3Endpoint string    Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
   -v, --verbose              Sets verbose level
 ```

docs/content/config/command-lists.md

@@ -35,12 +35,12 @@ If a remote config file is specified (on the command-line using `-f`) and the li
 ```
 
 | key | description | type | required
-| --- | --- | --- | --- |
-| `order` | Defines the sequence of commands to execute | `[]string` | yes |
-| `getOutput` | Command(s) output is in the notification(s) | `bool` | no |
-| `notifications` | The notification service(s) and ID(s) to use on success and failure. Must be *`service.id`*. See the [notifications documentation page](/config/notifications/) for more | `[]string` | no |
-| `name` | Optional name of the list | `string` | no |
-| `cron` | Time at which to schedule the list. Only has affect when cron subcommand is run. | `string` | no |
+| --- | --- | --- | ---
+| `order` | Defines the sequence of commands to execute | `[]string` | yes
+| `sendNotificationOnSuccess` | Whether to send notification on list success with the commands' output | `bool` | no
+| `notifications` | The notification service(s) and ID(s) to use on success and failure. Must be *`service.id`*. See the [notifications documentation page](/config/notifications/) for more | `[]string` | no
+| `name` | Optional name of the list | `string` | no
+| `cron` | Time at which to schedule the list. Only has affect when cron subcommand is run. | `string` | no
 
 ### Order
 

docs/content/config/hosts.md

@@ -21,4 +21,4 @@ description: >
 
 ## exec host subcommand
 
-Backy has a subcommand `exec host`. This subcommand takes the flags of `-m host1 -m host2`. For now these hosts need to be defined in the config file.
+Backy has a subcommand `exec host`. This subcommand takes the flags of `-m host1 -m host2`. The commands can also be specified by `-c command1 -c command2`.

docs/content/getting-started/config.md

@@ -124,13 +124,13 @@ notifications:
 
 ### Logging
 
-cmd-std-out controls whether commands output is echoed to StdOut.
+`cmd-std-out` controls whether commands output is echoed to StdOut.
 
-If logfile is not defined, the log file will be written to the config directory in the file `backy.log`.
+If `logfile` is not defined, the log file will be written to the config directory in the file `backy.log`.
 
 `console-disabled` controls whether the logging messages are echoed to StdOut. Default is false.
 
-`verbose` basically does nothing as all necessary info is already output.
+`verbose` prints out debugging messages.
 
 ```yaml
 logging:
@@ -144,7 +144,7 @@ logging:
 
 [Vault](https://www.vaultproject.io/) can be used to get some configuration values and ENV variables securely.
 
-```
+```yaml
 vault:
   token: hvs.tXqcASvTP8wg92f7riyvGyuf
   address: http://127.0.0.1:8200

docs/go.mod

@@ -3,6 +3,6 @@ module git.andrewnw.xyz/CyberShell/backy/docs
 go 1.19
 
 require (
-	github.com/McShelby/hugo-theme-relearn v0.0.0-20250103114405-80e448e5bdaa // indirect
-	github.com/divinerites/plausible-hugo v1.21.1 // indirect
+	github.com/McShelby/hugo-theme-relearn v0.0.0-20251115105808-d9ca8e8d8f59 // indirect
+	github.com/divinerites/plausible-hugo v1.22.0 // indirect
 )

docs/go.sum

@@ -1,10 +1,4 @@
-github.com/McShelby/hugo-theme-relearn v0.0.0-20230209073138-890d12ea922d h1:weq1mrQ/qNAvGrNgvZVL1K8adbT3bswZf2ABLr/LCIA=
-github.com/McShelby/hugo-theme-relearn v0.0.0-20230209073138-890d12ea922d/go.mod h1:mKQQdxZNIlLvAj8X3tMq+RzntIJSr9z7XdzuMomt0IM=
-github.com/McShelby/hugo-theme-relearn v0.0.0-20241210183303-16d4de84becf h1:bMx4kwM7Q+dAzvSOWs3XWZ25o+n4mI0GPHqzbzeWb3M=
-github.com/McShelby/hugo-theme-relearn v0.0.0-20241210183303-16d4de84becf/go.mod h1:mKQQdxZNIlLvAj8X3tMq+RzntIJSr9z7XdzuMomt0IM=
-github.com/McShelby/hugo-theme-relearn v0.0.0-20250102210630-dd0597ffa4b2 h1:sWaC1/dL65v3iRvblEAaBLpKC5TIT0R9JASk1hZNET8=
-github.com/McShelby/hugo-theme-relearn v0.0.0-20250102210630-dd0597ffa4b2/go.mod h1:mKQQdxZNIlLvAj8X3tMq+RzntIJSr9z7XdzuMomt0IM=
-github.com/McShelby/hugo-theme-relearn v0.0.0-20250103114405-80e448e5bdaa h1:G+OnMEzK4XOzbbcf1SmaGyOYJ0h5idp/IJdguWs8ioU=
-github.com/McShelby/hugo-theme-relearn v0.0.0-20250103114405-80e448e5bdaa/go.mod h1:mKQQdxZNIlLvAj8X3tMq+RzntIJSr9z7XdzuMomt0IM=
-github.com/divinerites/plausible-hugo v1.21.1 h1:ZTWwjhZ0PmLMacCVGlcGiYFEZW7VaYE767tchDskOug=
-github.com/divinerites/plausible-hugo v1.21.1/go.mod h1:cxr+YB3FUwbLon8KCs4pV4Ankbkq6lJxTQUpNb5KqPo=
+github.com/McShelby/hugo-theme-relearn v0.0.0-20251115105808-d9ca8e8d8f59 h1:mnEjz/Wrpv6Hea26KeFJPx94w9g9ZHIurUEWvPdaEvs=
+github.com/McShelby/hugo-theme-relearn v0.0.0-20251115105808-d9ca8e8d8f59/go.mod h1:mKQQdxZNIlLvAj8X3tMq+RzntIJSr9z7XdzuMomt0IM=
+github.com/divinerites/plausible-hugo v1.22.0 h1:2pZheSaIMc+EtwcEeZv0ioU2qBOEZa1Ii7IaR/9II9k=
+github.com/divinerites/plausible-hugo v1.22.0/go.mod h1:cxr+YB3FUwbLon8KCs4pV4Ankbkq6lJxTQUpNb5KqPo=

docs/layouts/_default/baseof.html

@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 {{- block "storeOutputFormat" . }}{{ end }}
 {{- if .IsHome }}
-  {{- $hugoVersion := "0.126.0" }}
+  {{- $hugoVersion := "0.141.0" }}
   {{- if lt hugo.Version $hugoVersion }}
     {{- errorf "The Relearn theme requires Hugo %s or later" $hugoVersion }}
   {{- end }}
@@ -36,12 +36,12 @@
     {{ (printf $link (partial "permalink.gotmpl" (dict "to" .)) .Rel .MediaType.Type ($title | htmlEscape)) | safeHTML }}
       {{- end }}
     {{- end }}
+
     {{- partialCached "favicon.html" . }}
-    {{- partial "stylesheet.html" . }}
-    {{- partial "dependencies.gotmpl" (dict "page" . "location" "header") }}
+    {{- partial "dependencies.html" (dict "page" . "location" "header") }}
     {{- partial "custom-header.html" . }}
   </head>
-  <body class="mobile-support {{ with .Store.Get "relearnOutputFormat" }}{{ . }}{{ else }}html{{ end }}{{- if .Site.Params.disableInlineCopyToClipBoard }} disableInlineCopyToClipboard{{ end }}{{- if .Site.Params.disableHoverBlockCopyToClipBoard }} disableHoverBlockCopyToClipBoard{{ end }}" data-url="{{ partial "permalink.gotmpl" (dict "to" .) }}">
+  <body class="mobile-support {{ with .Store.Get "relearnOutputFormat" }}{{ . }}{{ else }}html{{ end }}{{- if .Site.Params.disableHoverBlockCopyToClipBoard }} disableHoverBlockCopyToClipBoard{{ end }}" data-url="{{ partial "permalink.gotmpl" (dict "to" .) }}">
     <div id="R-body" class="default-animation">
       <div id="R-body-overlay"></div>
       <nav id="R-topbar">
@@ -53,7 +53,7 @@
           {{- $showBreadcrumb := (and (not .Params.disableBreadcrumb) (not .Site.Params.disableBreadcrumb)) }}
           {{- if $showBreadcrumb }}
           <ol class="topbar-breadcrumbs breadcrumbs highlightable" itemscope itemtype="http://schema.org/BreadcrumbList">
-            {{- partial "breadcrumbs.html" (dict "page" .) }}
+            {{- partial "breadcrumbs.html" (dict "page" . "schema" true) }}
           </ol>
           {{- else }}
           <span class="topbar-breadcrumbs highlightable">
@@ -74,11 +74,8 @@
 {{- partial "custom-comments.html" . }}
     </div>
 {{- block "menu" . }}{{ end }}
-{{- $assetBusting := partialCached "assetbusting.gotmpl" . }}
-    <script src="{{"js/clipboard.min.js" | relURL}}{{ $assetBusting }}" defer></script>
-    <script src="{{"js/perfect-scrollbar.min.js" | relURL}}{{ $assetBusting }}" defer></script>
-{{- partial "dependencies.gotmpl" (dict "page" . "location" "footer") }}
-    <script src="{{"js/theme.js" | relURL}}{{ $assetBusting }}" defer></script>
+{{- partial "dependencies.html" (dict "page" . "location" "footer") }}
 {{- partial "custom-footer.html" . }}
+    <div id="toast-container" role="status" aria-live="polite" aria-atomic="false"></div>
   </body>
-</html>
+</html>