Add page descriptions

[rbdr/r.bdr.sh] / swiftbar_scripts.gmi

diff --git a/swiftbar_scripts.gmi b/swiftbar_scripts.gmi
index 826e6fa2060a2418065937d6c41fd59d912c75dd..030b526f5c95e259cd24b90984a96d3b297132b4 100644 (file)
--- a/swiftbar_scripts.gmi
+++ b/swiftbar_scripts.gmi
@@ -1,3 +1,5 @@
+--- title: swiftbar_scripts.html
+--- description: Assorted SwiftBar scripts and utilities I've built.

 ## SwiftBar Scripts 
 
 This page holds the SwiftBar[1] / xbar scripts I've made. Since I use the first
 ## SwiftBar Scripts 
 
 This page holds the SwiftBar[1] / xbar scripts I've made. Since I use the first


@@ -8,14 +10,77 @@ one, I'm not sure whether they work with xbar[2], but should probably be OK.
 
 ## Sourcehut Builds
 
 
 ## Sourcehut Builds
 

-View the status of your last few builds in sourcehut. You can open the URL by
-clicking on the menu items.
-The count of failed, pending and successful runs of the last 15m are shown
-next to the icon.
+View the status of your last few builds in sourcehut. You can open the URL by clicking on the menu items. The count of failed, pending and successful runs of the last 15m are shown next to the icon.

 
 

-To use the plugin you'll need to set your sourcehut token in the
-VAR_SOURCEHUT_API_TOKEN variable (See the 'ADD YOUR TOKEN HERE' string). You
-can also control how many builds to show by changing the VAR_BUILD_COUNT
-variable (defaults to 5)
+### Dependencies

 
 

-=> ./swiftbar/sourcehut-builds.1m.sh ⧇ source
+You must have jq and curl installed.
+
+### Usage
+
+To use the plugin you'll need to set your sourcehut token in the VAR_SOURCEHUT_API_TOKEN variable (See the 'ADD YOUR TOKEN HERE' string). You can also control how many builds to show by changing the VAR_BUILD_COUNT variable (defaults to 5)
+
+### Focus Checks
+
+This script includes focus checks (See focus checks column at the end of this page on how to use them.)
+
+=> ./swiftbar/sourcehut-builds.1m.sh ⧇ sourcehut-builds.1m.sh
+
+## Monitorcito Bar
+
+View your monitorcito[3] tracked services at a glance. ○ is shown if everything is OK, and ╳ if at least one service is failing. Clicking on an item refreshes the status.
+
+### Dependencies
+
+You must have jq and curl installed.
+
+### Usage
+
+You can control the URL of the monitorcito instance by adjusting VAR_MONITORCITO_URL
+
+### Focus Checks
+
+This script includes focus checks (See focus checks column at the end of this page on how to use them.)
+
+=> https://git.sr.ht/~rbdr/monitorcito [3] Monitorcito
+=> ./swiftbar/monitorcito.1m.sh ⧇ monitorcito.1m.sh
+
+## Focus Checks
+
+This is a utility that allows other scripts to conditionally run or halt based on which focus mode is enabled.
+
+### Dependencies
+
+You must have jq installed .
+
+### Usage
+
+To enable the focus checks, you need to pass separated strings to VAR_RUN_ON_FOCUS or VAR_HALT_ON_FOCUS. For example, this will only run the script if "Personal" or "Do Not Disturb" are active:
+
+```
+VAR_RUN_ON_FOCUS="Personal|Do Not Disturb"
+```
+
+And this will halt the script only if the focus is Work
+
+```
+VAR_HALT_ON_FOCUS="Work"
+```
+
+If neither variable is set, then all checks will be disabled.
+
+The script will only appear or disappear when it's next refreshed. If you want this faster, trigger a full refresh of your plugins.
+
+### Setup
+
+Download and copy focus.utils.sh to your SwiftBar directory on the same directory as the scripts that use this functionality.
+
+### Permissions
+
+For the script to correctly get focus data, it requires full disk access. You can do this by going to System Settings > Privacy & Security > Full Disk Access, and adding SwiftBar to the list.
+
+### For Developers
+
+If you want to include this functionality in your script, check the script comments for instructions on how to use it in your scripts.
+
+=> ./swiftbar/focus.utils.sh ⧇ focus.utils.sh