From d6ae81af13340eca4f8fbd4a381bcada988ab4e9 Mon Sep 17 00:00:00 2001
From: LGUG2Z <LGUG2Z@fastmail.com>
Date: Thu, 26 Sep 2024 20:22:37 -0700
Subject: [PATCH] docs(mkdocs): generate latest cli docs

---
 docs/cli/animation-duration.md     | 16 ++++++++++++++++
 docs/cli/animation-fps.md          | 16 ++++++++++++++++
 docs/cli/animation-style.md        | 20 ++++++++++++++++++++
 docs/cli/animation.md              | 16 ++++++++++++++++
 docs/cli/bar-configuration.md      | 12 ++++++++++++
 docs/cli/complete-configuration.md |  2 +-
 docs/cli/enable-autostart.md       |  3 +++
 docs/cli/focus-stack-window.md     | 16 ++++++++++++++++
 docs/cli/reload-configuration.md   |  2 +-
 docs/cli/replace-configuration.md  | 16 ++++++++++++++++
 docs/cli/start.md                  |  3 +++
 docs/cli/stop.md                   |  3 +++
 docs/cli/toggle-transparency.md    | 12 ++++++++++++
 docs/cli/watch-configuration.md    |  2 +-
 justfile                           |  2 +-
 komorebic/src/main.rs              |  9 +++++----
 mkdocs.yml                         | 12 ++++++++++--
 17 files changed, 152 insertions(+), 10 deletions(-)
 create mode 100644 docs/cli/animation-duration.md
 create mode 100644 docs/cli/animation-fps.md
 create mode 100644 docs/cli/animation-style.md
 create mode 100644 docs/cli/animation.md
 create mode 100644 docs/cli/bar-configuration.md
 create mode 100644 docs/cli/focus-stack-window.md
 create mode 100644 docs/cli/replace-configuration.md
 create mode 100644 docs/cli/toggle-transparency.md

diff --git a/docs/cli/animation-duration.md b/docs/cli/animation-duration.md
new file mode 100644
index 00000000..3eb49e65
--- /dev/null
+++ b/docs/cli/animation-duration.md
@@ -0,0 +1,16 @@
+# animation-duration
+
+```
+Set the duration for movement animations in ms
+
+Usage: komorebic.exe animation-duration <DURATION>
+
+Arguments:
+  <DURATION>
+          Desired animation durations in ms
+
+Options:
+  -h, --help
+          Print help
+
+```
diff --git a/docs/cli/animation-fps.md b/docs/cli/animation-fps.md
new file mode 100644
index 00000000..5845c0ff
--- /dev/null
+++ b/docs/cli/animation-fps.md
@@ -0,0 +1,16 @@
+# animation-fps
+
+```
+Set the frames per second for movement animations
+
+Usage: komorebic.exe animation-fps <FPS>
+
+Arguments:
+  <FPS>
+          Desired animation frames per second
+
+Options:
+  -h, --help
+          Print help
+
+```
diff --git a/docs/cli/animation-style.md b/docs/cli/animation-style.md
new file mode 100644
index 00000000..d2f2ee03
--- /dev/null
+++ b/docs/cli/animation-style.md
@@ -0,0 +1,20 @@
+# animation-style
+
+```
+Set the ease function for movement animations
+
+Usage: komorebic.exe animation-style [OPTIONS]
+
+Options:
+  -s, --style <STYLE>
+          Desired ease function for animation
+          
+          [default: linear]
+          [possible values: linear, ease-in-sine, ease-out-sine, ease-in-out-sine, ease-in-quad, ease-out-quad, ease-in-out-quad, ease-in-cubic, ease-in-out-cubic, ease-in-quart,
+          ease-out-quart, ease-in-out-quart, ease-in-quint, ease-out-quint, ease-in-out-quint, ease-in-expo, ease-out-expo, ease-in-out-expo, ease-in-circ, ease-out-circ, ease-in-out-circ,
+          ease-in-back, ease-out-back, ease-in-out-back, ease-in-elastic, ease-out-elastic, ease-in-out-elastic, ease-in-bounce, ease-out-bounce, ease-in-out-bounce]
+
+  -h, --help
+          Print help
+
+```
diff --git a/docs/cli/animation.md b/docs/cli/animation.md
new file mode 100644
index 00000000..c088949e
--- /dev/null
+++ b/docs/cli/animation.md
@@ -0,0 +1,16 @@
+# animation
+
+```
+Enable or disable movement animations
+
+Usage: komorebic.exe animation <BOOLEAN_STATE>
+
+Arguments:
+  <BOOLEAN_STATE>
+          [possible values: enable, disable]
+
+Options:
+  -h, --help
+          Print help
+
+```
diff --git a/docs/cli/bar-configuration.md b/docs/cli/bar-configuration.md
new file mode 100644
index 00000000..b9322802
--- /dev/null
+++ b/docs/cli/bar-configuration.md
@@ -0,0 +1,12 @@
+# bar-configuration
+
+```
+Show the path to komorebi.bar.json
+
+Usage: komorebic.exe bar-configuration
+
+Options:
+  -h, --help
+          Print help
+
+```
diff --git a/docs/cli/complete-configuration.md b/docs/cli/complete-configuration.md
index 904d7b1d..42c189d9 100644
--- a/docs/cli/complete-configuration.md
+++ b/docs/cli/complete-configuration.md
@@ -1,7 +1,7 @@
 # complete-configuration
 
 ```
-Signal that the final configuration option has been sent
+For legacy komorebi.ahk or komorebi.ps1 configurations, signal that the final configuration option has been sent
 
 Usage: komorebic.exe complete-configuration
 
diff --git a/docs/cli/enable-autostart.md b/docs/cli/enable-autostart.md
index c04bb84e..3adcbc72 100644
--- a/docs/cli/enable-autostart.md
+++ b/docs/cli/enable-autostart.md
@@ -18,6 +18,9 @@ Options:
       --ahk
           Enable autostart of ahk
 
+      --bar
+          Enable autostart of komorebi-bar
+
   -h, --help
           Print help
 
diff --git a/docs/cli/focus-stack-window.md b/docs/cli/focus-stack-window.md
new file mode 100644
index 00000000..a058f5bf
--- /dev/null
+++ b/docs/cli/focus-stack-window.md
@@ -0,0 +1,16 @@
+# focus-stack-window
+
+```
+Focus the specified window index in the focused stack
+
+Usage: komorebic.exe focus-stack-window <TARGET>
+
+Arguments:
+  <TARGET>
+          Target index (zero-indexed)
+
+Options:
+  -h, --help
+          Print help
+
+```
diff --git a/docs/cli/reload-configuration.md b/docs/cli/reload-configuration.md
index 1dd636ce..36a0ec2d 100644
--- a/docs/cli/reload-configuration.md
+++ b/docs/cli/reload-configuration.md
@@ -1,7 +1,7 @@
 # reload-configuration
 
 ```
-Reload ~/komorebi.ahk (if it exists)
+Reload legacy komorebi.ahk or komorebi.ps1 configurations (if they exist)
 
 Usage: komorebic.exe reload-configuration
 
diff --git a/docs/cli/replace-configuration.md b/docs/cli/replace-configuration.md
new file mode 100644
index 00000000..2a4a2bfe
--- /dev/null
+++ b/docs/cli/replace-configuration.md
@@ -0,0 +1,16 @@
+# replace-configuration
+
+```
+Replace the configuration of a running instance of komorebi from a static configuration file
+
+Usage: komorebic.exe replace-configuration <PATH>
+
+Arguments:
+  <PATH>
+          Static configuration JSON file from which the configuration should be loaded
+
+Options:
+  -h, --help
+          Print help
+
+```
diff --git a/docs/cli/start.md b/docs/cli/start.md
index a5e17c55..c7b449c9 100644
--- a/docs/cli/start.md
+++ b/docs/cli/start.md
@@ -24,6 +24,9 @@ Options:
       --ahk
           Start autohotkey configuration file
 
+      --bar
+          Start komorebi-bar in a background process
+
   -h, --help
           Print help
 
diff --git a/docs/cli/stop.md b/docs/cli/stop.md
index 11d42589..ecfde2f9 100644
--- a/docs/cli/stop.md
+++ b/docs/cli/stop.md
@@ -9,6 +9,9 @@ Options:
       --whkd
           Stop whkd if it is running as a background process
 
+      --bar
+          Stop komorebi-bar if it is running as a background process
+
   -h, --help
           Print help
 
diff --git a/docs/cli/toggle-transparency.md b/docs/cli/toggle-transparency.md
new file mode 100644
index 00000000..427d0ffb
--- /dev/null
+++ b/docs/cli/toggle-transparency.md
@@ -0,0 +1,12 @@
+# toggle-transparency
+
+```
+Toggle transparency for unfocused windows
+
+Usage: komorebic.exe toggle-transparency
+
+Options:
+  -h, --help
+          Print help
+
+```
diff --git a/docs/cli/watch-configuration.md b/docs/cli/watch-configuration.md
index 40d5fda9..23ae4eb4 100644
--- a/docs/cli/watch-configuration.md
+++ b/docs/cli/watch-configuration.md
@@ -1,7 +1,7 @@
 # watch-configuration
 
 ```
-Enable or disable watching of ~/komorebi.ahk (if it exists)
+Enable or disable watching of legacy komorebi.ahk or komorebi.ps1 configurations (if they exist)
 
 Usage: komorebic.exe watch-configuration <BOOLEAN_STATE>
 
diff --git a/justfile b/justfile
index cb8961b8..e17e60f3 100644
--- a/justfile
+++ b/justfile
@@ -42,7 +42,7 @@ deadlock $RUST_LOG="trace":
     cargo +stable run --bin komorebi --locked --features deadlock_detection
 
 docgen:
-    komorebic docgen
+    cargo run --package komorebic -- docgen
     Get-ChildItem -Path "docs/cli" -Recurse -File | ForEach-Object { (Get-Content $_.FullName) -replace 'Usage: ', 'Usage: komorebic.exe ' | Set-Content $_.FullName }
 
 schemagen:
diff --git a/komorebic/src/main.rs b/komorebic/src/main.rs
index 1cb24a50..dba7e760 100644
--- a/komorebic/src/main.rs
+++ b/komorebic/src/main.rs
@@ -897,6 +897,7 @@ enum SubCommand {
     /// Show the path to komorebi.json
     #[clap(alias = "config")]
     Configuration,
+    /// Show the path to komorebi.bar.json
     #[clap(alias = "bar-config")]
     #[clap(alias = "bconfig")]
     BarConfiguration,
@@ -1281,16 +1282,16 @@ enum SubCommand {
     TransparencyAlpha(TransparencyAlpha),
     /// Toggle transparency for unfocused windows
     ToggleTransparency,
-    /// Enable or disable the window move animation
+    /// Enable or disable movement animations
     #[clap(arg_required_else_help = true)]
     Animation(Animation),
-    /// Set the duration for the window move animation in ms
+    /// Set the duration for movement animations in ms
     #[clap(arg_required_else_help = true)]
     AnimationDuration(AnimationDuration),
-    /// Set the frames per second for the window move animation
+    /// Set the frames per second for movement animations
     #[clap(arg_required_else_help = true)]
     AnimationFps(AnimationFps),
-    /// Set the ease function for the window move animation
+    /// Set the ease function for movement animations
     #[clap(arg_required_else_help = true)]
     AnimationStyle(AnimationStyle),
     /// Enable or disable focus follows mouse for the operating system
diff --git a/mkdocs.yml b/mkdocs.yml
index a1741cd1..a4d7218f 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -79,6 +79,7 @@ nav:
       - cli/stop.md
       - cli/check.md
       - cli/configuration.md
+      - cli/bar-configuration.md
       - cli/whkdrc.md
       - cli/state.md
       - cli/global-state.md
@@ -103,12 +104,13 @@ nav:
       - cli/cycle-focus.md
       - cli/cycle-move.md
       - cli/stack.md
+      - cli/unstack.md
+      - cli/cycle-stack.md
+      - cli/focus-stack-window.md
       - cli/stack-all.md
       - cli/unstack-all.md
       - cli/resize-edge.md
       - cli/resize-axis.md
-      - cli/unstack.md
-      - cli/cycle-stack.md
       - cli/move-to-monitor.md
       - cli/cycle-move-to-monitor.md
       - cli/move-to-workspace.md
@@ -179,6 +181,7 @@ nav:
       - cli/restore-windows.md
       - cli/manage.md
       - cli/unmanage.md
+      - cli/replace-configuration.md
       - cli/reload-configuration.md
       - cli/watch-configuration.md
       - cli/complete-configuration.md
@@ -208,6 +211,11 @@ nav:
       - cli/border-implementation.md
       - cli/transparency.md
       - cli/transparency-alpha.md
+      - cli/toggle-transparency.md
+      - cli/animation.md
+      - cli/animation-duration.md
+      - cli/animation-fps.md
+      - cli/animation-style.md
       - cli/focus-follows-mouse.md
       - cli/toggle-focus-follows-mouse.md
       - cli/mouse-follows-focus.md