Issue #175: Add settings.yaml documentation

F1bonacc1 · May 6, 2024 · 6b0a775 · 6b0a775
1 parent c71d82d
commit 6b0a775
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/www/docs/tui.md b/www/docs/tui.md
@@ -160,3 +160,25 @@ style:
     logoColor: '#0000FF' #blue
 ```
 
+## TUI State Settings
+
+TUI will automatically save its state when the after changing the following:
+
+1. TUI Theme
+2. Processes sort column
+3. Processes sort order (ascending / descending)
+
+`settings.yaml` file location `$XDG_CONFIG_HOME/process-compose/`
+
+#### Settings Structure
+
+```yaml
+#XDG_CONFIG_HOME/process-compose/settings.yaml
+
+theme: Cobalt
+sort:
+    by: NAME
+    isReversed: false
+```
+
+> :bulb: The auto save feature can be disabled by using the `--read-only` flag.