Documentation and example

README.md

@@ -98,6 +98,21 @@ You can also execute Shui from standard input, which works like query mode.
 while true; do uptime; sleep 1; done | shui
 ```
 
+### Configuration
+
+Shui can accept instruction from flags or from a configuration file. By default it will look for a
+`shui.toml` in the user's config directory (see: <https://pkg.go.dev/os#UserConfigDir>), but one may
+also be provided explicitly.
+
+```sh
+shui --config path/to/config  # Default is "${HOME}/.config/shui/shui.toml".
+```
+
+See [examples/shui.toml](examples/shui.toml) for an example.
+
+> NOTE: Most options may be mixed, but queries and expressions may only be supplied with flags or
+> configuration, not both.
+
 ### Persistence
 
 Shui, by default, will store results and load them when re-executing the same query.

cmd/shui/main.go

@@ -45,19 +45,19 @@ var (
 	// Aliases to apply for configuration settings, mainly to account for differences between flags
 	// (the left column) and configuration files (the right column).
 	configurationAliases = map[string]string{
-		"elasticsearch-addr":     "elasticsearch.addr",
-		"elasticsearch-index":    "elasticsearch.index",
-		"elasticsearch-password": "elasticsearch.password",
-		"elasticsearch-user":     "elasticsearch.user",
-		"outer-padding-bottom":   "tui.padding.bottom",
-		"outer-padding-left":     "tui.padding.left",
-		"outer-padding-right":    "tui.padding.right",
-		"outer-padding-top":      "tui.padding.top",
-		"prometheus-exporter":    "prometheus.exporter",
-		"prometheus-pushgateway": "prometheus.pushgateway",
-		"show-help":              "tui.show.help",
-		"show-logs":              "tui.show.logs",
-		"show-status":            "tui.show.status",
+		"elasticsearch.addr":     "elasticsearch-addr",
+		"elasticsearch.index":    "elasticsearch-index",
+		"elasticsearch.password": "elasticsearch-password",
+		"elasticsearch.user":     "elasticsearch-user",
+		"tui.padding.bottom":     "outer-padding-bottom",
+		"tui.padding.left":       "outer-padding-left",
+		"tui.padding.right":      "outer-padding-right",
+		"tui.padding.top":        "outer-padding-top",
+		"prometheus.exporter":    "prometheus-exporter",
+		"prometheus.pushgateway": "prometheus-pushgateway",
+		"tui.show.help":          "show-help",
+		"tui.show.logs":          "show-logs",
+		"tui.show.status":        "show-status",
 	}
 
 	logger                 = log.Default() // Logging system.

example/shui.toml

@@ -0,0 +1,52 @@
+#
+# Sample configuration file for Shui that reads CPU load averages.
+
+count = -1
+display = 4
+history = false
+log-level = "debug"
+
+filters = [
+  "CPU load average"
+]
+
+labels = [
+  "CPU load average"
+]
+
+expressions = [
+  "get(result, 'CPU load average') * 100"
+]
+
+[tui.padding]
+bottom = 0
+top = 0
+left = 0
+right = 0
+
+[tui.show]
+help = true
+logs = true
+status = true
+
+# 1 minute CPU load average
+[[query]]
+command = "uptime | awk '{print $10}' | tr -d ','"
+
+# 5 minute CPU load average
+[[query]]
+command = "uptime | awk '{print $11}' | tr -d ','"
+
+# 15 minute CPU load average
+[[query]]
+command = "uptime | awk '{print $12}' | tr -d ','"
+
+# [elasticsearch]
+# addr = "https://localhost:9200"
+# index = "shui"
+# password = ""
+# user = "elastic"
+
+# [prometheus]
+# exporter = "127.0.0.1:9898"
+# pushgateway = "127.0.0.1:9091"