From 9741b29a7c9c841fff3449ea89a30d0fa3f4f6f1 Mon Sep 17 00:00:00 2001
From: David Heinemeier Hansson <david@hey.com>
Date: Sat, 7 Feb 2026 10:50:48 +0100
Subject: [PATCH] Describe the rest of the bins

---
 bin/omarchy-battery-present    | 3 +++
 bin/omarchy-remove-dev-env     | 3 +++
 bin/omarchy-reset-sudo         | 3 +++
 bin/omarchy-restart-app        | 3 +++
 bin/omarchy-restart-bluetooth  | 2 ++
 bin/omarchy-restart-hypridle   | 2 ++
 bin/omarchy-restart-hyprsunset | 2 ++
 bin/omarchy-restart-pipewire   | 2 ++
 bin/omarchy-restart-wifi       | 2 ++
 bin/omarchy-restart-xcompose   | 2 ++
 bin/omarchy-show-done          | 3 +++
 bin/omarchy-show-logo          | 3 +++
 bin/omarchy-state              | 4 ++++
 13 files changed, 34 insertions(+)

diff --git a/bin/omarchy-battery-present b/bin/omarchy-battery-present
index 9d859c3c..bcdab1eb 100755
--- a/bin/omarchy-battery-present
+++ b/bin/omarchy-battery-present
@@ -1,5 +1,8 @@
 #!/bin/bash
 
+# Returns true if a battery is present on the system.
+# Used by the battery monitor and other battery-related checks.
+
 for bat in /sys/class/power_supply/BAT*; do
   [[ -r "$bat/present" ]] &&
   [[ "$(cat "$bat/present")" == "1" ]] &&
diff --git a/bin/omarchy-remove-dev-env b/bin/omarchy-remove-dev-env
index d2320149..2431a09a 100755
--- a/bin/omarchy-remove-dev-env
+++ b/bin/omarchy-remove-dev-env
@@ -1,5 +1,8 @@
 #!/bin/bash
 
+# Remove a development environment that was previously installed via omarchy-install-dev-env.
+# Usage: omarchy-remove-dev-env <ruby|node|bun|deno|go|php|laravel|symfony|python|elixir|phoenix|zig|rust|java|dotnet|ocaml|clojure>
+
 if [[ -z "$1" ]]; then
   echo "Usage: omarchy-remove-dev-env <ruby|node|bun|deno|go|php|laravel|symfony|python|elixir|phoenix|zig|rust|java|dotnet|ocaml|clojure>" >&2
   exit 1
diff --git a/bin/omarchy-reset-sudo b/bin/omarchy-reset-sudo
index 94822623..2c568469 100755
--- a/bin/omarchy-reset-sudo
+++ b/bin/omarchy-reset-sudo
@@ -1,4 +1,7 @@
 #!/bin/bash
 
+# Reset the sudo lockout/faillock for the current user.
+# This clears any failed authentication attempts that may have locked the user out.
+
 # Resetting sudo lockout for user
 su -c "faillock --reset --user $USER"
diff --git a/bin/omarchy-restart-app b/bin/omarchy-restart-app
index 4cc474fa..6e0a46ad 100755
--- a/bin/omarchy-restart-app
+++ b/bin/omarchy-restart-app
@@ -1,4 +1,7 @@
 #!/bin/bash
 
+# Restart an application by killing it and relaunching via uwsm.
+# Usage: omarchy-restart-app <application-name>
+
 pkill -x $1
 setsid uwsm-app -- $1 >/dev/null 2>&1 &
diff --git a/bin/omarchy-restart-bluetooth b/bin/omarchy-restart-bluetooth
index 1d3c6c11..57530d10 100755
--- a/bin/omarchy-restart-bluetooth
+++ b/bin/omarchy-restart-bluetooth
@@ -1,5 +1,7 @@
 #!/bin/bash
 
+# Unblock and restart the bluetooth service.
+
 echo -e "Unblocking bluetooth...\n"
 rfkill unblock bluetooth
 rfkill list bluetooth
diff --git a/bin/omarchy-restart-hypridle b/bin/omarchy-restart-hypridle
index 261f0aa3..02186267 100755
--- a/bin/omarchy-restart-hypridle
+++ b/bin/omarchy-restart-hypridle
@@ -1,3 +1,5 @@
 #!/bin/bash
 
+# Restart the hypridle service (used for idle detection and auto-lock).
+
 omarchy-restart-app hypridle
diff --git a/bin/omarchy-restart-hyprsunset b/bin/omarchy-restart-hyprsunset
index 0e681bfd..c705ab53 100755
--- a/bin/omarchy-restart-hyprsunset
+++ b/bin/omarchy-restart-hyprsunset
@@ -1,3 +1,5 @@
 #!/bin/bash
 
+# Restart the hyprsunset service (used for blue light filtering/night light).
+
 omarchy-restart-app hyprsunset
diff --git a/bin/omarchy-restart-pipewire b/bin/omarchy-restart-pipewire
index f26ee09e..a222ad1e 100755
--- a/bin/omarchy-restart-pipewire
+++ b/bin/omarchy-restart-pipewire
@@ -1,4 +1,6 @@
 #!/bin/bash
 
+# Restart the PipeWire audio service to fix audio issues or apply new configuration.
+
 echo -e "Restarting pipewire audio service...\n"
 systemctl --user restart pipewire.service
diff --git a/bin/omarchy-restart-wifi b/bin/omarchy-restart-wifi
index b4d66a5a..5cf35dd3 100755
--- a/bin/omarchy-restart-wifi
+++ b/bin/omarchy-restart-wifi
@@ -1,5 +1,7 @@
 #!/bin/bash
 
+# Unblock and restart the Wi-Fi service.
+
 echo -e "Unblocking wifi...\n"
 rfkill unblock wifi
 rfkill list wifi
diff --git a/bin/omarchy-restart-xcompose b/bin/omarchy-restart-xcompose
index 45f7d9a8..dcbd237f 100755
--- a/bin/omarchy-restart-xcompose
+++ b/bin/omarchy-restart-xcompose
@@ -1,3 +1,5 @@
 #!/bin/bash
 
+# Restart the XCompose input method service (fcitx5) to apply new compose key settings.
+
 omarchy-restart-app fcitx5
diff --git a/bin/omarchy-show-done b/bin/omarchy-show-done
index de5fe2ab..36f5aec2 100755
--- a/bin/omarchy-show-done
+++ b/bin/omarchy-show-done
@@ -1,4 +1,7 @@
 #!/bin/bash
 
+# Display a "Done!" message with a spinner and wait for user to press any key.
+# Used by various install scripts to indicate completion.
+
 echo
 gum spin --spinner "globe" --title "Done! Press any key to close..." -- bash -c 'read -n 1 -s'
diff --git a/bin/omarchy-show-logo b/bin/omarchy-show-logo
index fbaf38df..a6137c58 100755
--- a/bin/omarchy-show-logo
+++ b/bin/omarchy-show-logo
@@ -1,5 +1,8 @@
 #!/bin/bash
 
+# Display the Omarchy logo in the terminal using green color.
+# Used by various presentation scripts to show branding.
+
 clear
 echo -e "\033[32m"
 cat <~/.local/share/omarchy/logo.txt
diff --git a/bin/omarchy-state b/bin/omarchy-state
index d55943b6..884b6d94 100755
--- a/bin/omarchy-state
+++ b/bin/omarchy-state
@@ -1,5 +1,9 @@
 #!/bin/bash
 
+# Manage persistent state files for Omarchy toggles and settings.
+# Usage: omarchy-state <set|clear> <state-name-or-pattern>
+# Used to track whether features like suspend, idle lock, etc are enabled or disabled.
+
 STATE_DIR="$HOME/.local/state/omarchy"
 mkdir -p "$STATE_DIR"