@fredlackey/devutils 0.0.1 → 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (259) hide show
  1. package/README.md +5 -5
  2. package/package.json +1 -1
  3. package/src/commands/install.js +374 -36
  4. package/src/installs/adobe-creative-cloud.js +527 -25
  5. package/src/installs/adobe-creative-cloud.md +605 -0
  6. package/src/installs/appcleaner.js +303 -26
  7. package/src/installs/appcleaner.md +699 -0
  8. package/src/installs/apt-transport-https.js +390 -0
  9. package/src/installs/apt-transport-https.md +678 -0
  10. package/src/installs/atomicparsley.js +624 -26
  11. package/src/installs/atomicparsley.md +795 -0
  12. package/src/installs/aws-cli.js +779 -26
  13. package/src/installs/aws-cli.md +727 -0
  14. package/src/installs/balena-etcher.js +688 -26
  15. package/src/installs/balena-etcher.md +761 -0
  16. package/src/installs/bambu-studio.js +912 -26
  17. package/src/installs/bambu-studio.md +780 -0
  18. package/src/installs/bash-completion.js +554 -23
  19. package/src/installs/bash-completion.md +833 -0
  20. package/src/installs/bash.js +399 -26
  21. package/src/installs/bash.md +993 -0
  22. package/src/installs/beyond-compare.js +585 -26
  23. package/src/installs/beyond-compare.md +813 -0
  24. package/src/installs/build-essential.js +511 -26
  25. package/src/installs/build-essential.md +977 -0
  26. package/src/installs/ca-certificates.js +618 -0
  27. package/src/installs/ca-certificates.md +937 -0
  28. package/src/installs/caffeine.js +490 -26
  29. package/src/installs/caffeine.md +839 -0
  30. package/src/installs/camtasia.js +577 -25
  31. package/src/installs/camtasia.md +762 -0
  32. package/src/installs/chatgpt.js +458 -26
  33. package/src/installs/chatgpt.md +814 -0
  34. package/src/installs/chocolatey.js +447 -0
  35. package/src/installs/chocolatey.md +661 -0
  36. package/src/installs/chrome-canary.js +472 -26
  37. package/src/installs/chrome-canary.md +641 -0
  38. package/src/installs/chromium.js +645 -26
  39. package/src/installs/chromium.md +838 -0
  40. package/src/installs/claude-code.js +558 -26
  41. package/src/installs/claude-code.md +1173 -0
  42. package/src/installs/curl.js +361 -26
  43. package/src/installs/curl.md +714 -0
  44. package/src/installs/cursor.js +561 -26
  45. package/src/installs/cursor.md +970 -0
  46. package/src/installs/dbschema.js +674 -26
  47. package/src/installs/dbschema.md +925 -0
  48. package/src/installs/dependencies.md +435 -0
  49. package/src/installs/development-tools.js +600 -0
  50. package/src/installs/development-tools.md +977 -0
  51. package/src/installs/docker.js +1010 -25
  52. package/src/installs/docker.md +1109 -0
  53. package/src/installs/drawio.js +1001 -26
  54. package/src/installs/drawio.md +795 -0
  55. package/src/installs/elmedia-player.js +328 -25
  56. package/src/installs/elmedia-player.md +556 -0
  57. package/src/installs/ffmpeg.js +870 -25
  58. package/src/installs/ffmpeg.md +852 -0
  59. package/src/installs/file.js +464 -0
  60. package/src/installs/file.md +987 -0
  61. package/src/installs/gemini-cli.js +793 -26
  62. package/src/installs/gemini-cli.md +1153 -0
  63. package/src/installs/git.js +382 -26
  64. package/src/installs/git.md +907 -0
  65. package/src/installs/gitego.js +931 -26
  66. package/src/installs/gitego.md +1172 -0
  67. package/src/installs/go.js +913 -26
  68. package/src/installs/go.md +958 -0
  69. package/src/installs/google-chrome.js +801 -25
  70. package/src/installs/google-chrome.md +862 -0
  71. package/src/installs/gpg.js +412 -73
  72. package/src/installs/gpg.md +1056 -0
  73. package/src/installs/homebrew.js +1015 -26
  74. package/src/installs/homebrew.md +988 -0
  75. package/src/installs/imageoptim.js +950 -26
  76. package/src/installs/imageoptim.md +1119 -0
  77. package/src/installs/installers.json +2297 -0
  78. package/src/installs/jq.js +382 -26
  79. package/src/installs/jq.md +809 -0
  80. package/src/installs/keyboard-maestro.js +701 -26
  81. package/src/installs/keyboard-maestro.md +825 -0
  82. package/src/installs/latex.js +771 -26
  83. package/src/installs/latex.md +1095 -0
  84. package/src/installs/lftp.js +338 -26
  85. package/src/installs/lftp.md +907 -0
  86. package/src/installs/lsb-release.js +346 -0
  87. package/src/installs/lsb-release.md +814 -0
  88. package/src/installs/messenger.js +829 -26
  89. package/src/installs/messenger.md +900 -0
  90. package/src/installs/microsoft-office.js +550 -26
  91. package/src/installs/microsoft-office.md +760 -0
  92. package/src/installs/microsoft-teams.js +782 -25
  93. package/src/installs/microsoft-teams.md +886 -0
  94. package/src/installs/node.js +886 -26
  95. package/src/installs/node.md +1153 -0
  96. package/src/installs/nordpass.js +698 -26
  97. package/src/installs/nordpass.md +921 -0
  98. package/src/installs/nvm.js +977 -26
  99. package/src/installs/nvm.md +1057 -0
  100. package/src/installs/openssh.js +734 -64
  101. package/src/installs/openssh.md +1056 -0
  102. package/src/installs/pandoc.js +644 -26
  103. package/src/installs/pandoc.md +1036 -0
  104. package/src/installs/pinentry.js +492 -26
  105. package/src/installs/pinentry.md +1142 -0
  106. package/src/installs/pngyu.js +851 -26
  107. package/src/installs/pngyu.md +896 -0
  108. package/src/installs/postman.js +781 -26
  109. package/src/installs/postman.md +940 -0
  110. package/src/installs/procps.js +425 -0
  111. package/src/installs/procps.md +851 -0
  112. package/src/installs/safari-tech-preview.js +355 -25
  113. package/src/installs/safari-tech-preview.md +533 -0
  114. package/src/installs/sfnt2woff.js +640 -26
  115. package/src/installs/sfnt2woff.md +795 -0
  116. package/src/installs/shellcheck.js +463 -26
  117. package/src/installs/shellcheck.md +1005 -0
  118. package/src/installs/slack.js +722 -25
  119. package/src/installs/slack.md +865 -0
  120. package/src/installs/snagit.js +566 -25
  121. package/src/installs/snagit.md +844 -0
  122. package/src/installs/software-properties-common.js +372 -0
  123. package/src/installs/software-properties-common.md +805 -0
  124. package/src/installs/spotify.js +858 -25
  125. package/src/installs/spotify.md +901 -0
  126. package/src/installs/studio-3t.js +803 -26
  127. package/src/installs/studio-3t.md +918 -0
  128. package/src/installs/sublime-text.js +780 -25
  129. package/src/installs/sublime-text.md +914 -0
  130. package/src/installs/superwhisper.js +687 -25
  131. package/src/installs/superwhisper.md +630 -0
  132. package/src/installs/tailscale.js +727 -26
  133. package/src/installs/tailscale.md +1100 -0
  134. package/src/installs/tar.js +389 -0
  135. package/src/installs/tar.md +946 -0
  136. package/src/installs/termius.js +780 -26
  137. package/src/installs/termius.md +844 -0
  138. package/src/installs/terraform.js +761 -26
  139. package/src/installs/terraform.md +899 -0
  140. package/src/installs/tidal.js +752 -25
  141. package/src/installs/tidal.md +864 -0
  142. package/src/installs/tmux.js +328 -26
  143. package/src/installs/tmux.md +1030 -0
  144. package/src/installs/tree.js +393 -26
  145. package/src/installs/tree.md +833 -0
  146. package/src/installs/unzip.js +460 -0
  147. package/src/installs/unzip.md +879 -0
  148. package/src/installs/vim.js +403 -26
  149. package/src/installs/vim.md +1040 -0
  150. package/src/installs/vlc.js +803 -26
  151. package/src/installs/vlc.md +927 -0
  152. package/src/installs/vscode.js +825 -26
  153. package/src/installs/vscode.md +1002 -0
  154. package/src/installs/wget.js +415 -0
  155. package/src/installs/wget.md +791 -0
  156. package/src/installs/whatsapp.js +710 -25
  157. package/src/installs/whatsapp.md +854 -0
  158. package/src/installs/winpty.js +352 -0
  159. package/src/installs/winpty.md +620 -0
  160. package/src/installs/woff2.js +535 -26
  161. package/src/installs/woff2.md +977 -0
  162. package/src/installs/wsl.js +572 -0
  163. package/src/installs/wsl.md +699 -0
  164. package/src/installs/xcode-clt.js +520 -0
  165. package/src/installs/xcode-clt.md +351 -0
  166. package/src/installs/xcode.js +542 -26
  167. package/src/installs/xcode.md +573 -0
  168. package/src/installs/yarn.js +806 -26
  169. package/src/installs/yarn.md +1074 -0
  170. package/src/installs/yq.js +636 -26
  171. package/src/installs/yq.md +944 -0
  172. package/src/installs/yt-dlp.js +683 -26
  173. package/src/installs/yt-dlp.md +946 -0
  174. package/src/installs/yum-utils.js +297 -0
  175. package/src/installs/yum-utils.md +648 -0
  176. package/src/installs/zoom.js +740 -25
  177. package/src/installs/zoom.md +884 -0
  178. package/src/scripts/README.md +567 -45
  179. package/src/scripts/STATUS.md +208 -0
  180. package/src/scripts/afk.js +395 -7
  181. package/src/scripts/backup-all.js +731 -9
  182. package/src/scripts/backup-source.js +711 -8
  183. package/src/scripts/brewd.js +373 -7
  184. package/src/scripts/brewi.js +505 -9
  185. package/src/scripts/brewr.js +512 -9
  186. package/src/scripts/brews.js +462 -9
  187. package/src/scripts/brewu.js +488 -7
  188. package/src/scripts/c.js +185 -7
  189. package/src/scripts/ccurl.js +325 -8
  190. package/src/scripts/certbot-crontab-init.js +488 -8
  191. package/src/scripts/certbot-init.js +641 -9
  192. package/src/scripts/ch.js +339 -7
  193. package/src/scripts/claude-danger.js +253 -8
  194. package/src/scripts/clean-dev.js +419 -8
  195. package/src/scripts/clear-dns-cache.js +525 -7
  196. package/src/scripts/clone.js +417 -7
  197. package/src/scripts/code-all.js +420 -7
  198. package/src/scripts/count-files.js +195 -8
  199. package/src/scripts/count-folders.js +195 -8
  200. package/src/scripts/count.js +248 -8
  201. package/src/scripts/d.js +203 -7
  202. package/src/scripts/datauri.js +373 -8
  203. package/src/scripts/delete-files.js +363 -7
  204. package/src/scripts/docker-clean.js +410 -8
  205. package/src/scripts/dp.js +426 -7
  206. package/src/scripts/e.js +375 -9
  207. package/src/scripts/empty-trash.js +497 -7
  208. package/src/scripts/evm.js +428 -9
  209. package/src/scripts/fetch-github-repos.js +441 -10
  210. package/src/scripts/get-channel.js +329 -8
  211. package/src/scripts/get-course.js +384 -11
  212. package/src/scripts/get-dependencies.js +290 -9
  213. package/src/scripts/get-folder.js +783 -10
  214. package/src/scripts/get-tunes.js +411 -10
  215. package/src/scripts/get-video.js +352 -9
  216. package/src/scripts/git-backup.js +561 -9
  217. package/src/scripts/git-clone.js +477 -9
  218. package/src/scripts/git-pup.js +303 -7
  219. package/src/scripts/git-push.js +380 -8
  220. package/src/scripts/h.js +607 -9
  221. package/src/scripts/hide-desktop-icons.js +483 -7
  222. package/src/scripts/hide-hidden-files.js +522 -7
  223. package/src/scripts/install-dependencies-from.js +440 -9
  224. package/src/scripts/ips.js +647 -10
  225. package/src/scripts/iso.js +354 -8
  226. package/src/scripts/killni.js +561 -7
  227. package/src/scripts/ll.js +451 -8
  228. package/src/scripts/local-ip.js +310 -8
  229. package/src/scripts/m.js +508 -8
  230. package/src/scripts/map.js +293 -8
  231. package/src/scripts/mkd.js +287 -7
  232. package/src/scripts/ncu-update-all.js +441 -8
  233. package/src/scripts/nginx-init.js +702 -12
  234. package/src/scripts/npmi.js +366 -7
  235. package/src/scripts/o.js +495 -8
  236. package/src/scripts/org-by-date.js +321 -7
  237. package/src/scripts/p.js +208 -7
  238. package/src/scripts/packages.js +313 -8
  239. package/src/scripts/path.js +209 -7
  240. package/src/scripts/ports.js +582 -8
  241. package/src/scripts/q.js +290 -8
  242. package/src/scripts/refresh-files.js +378 -10
  243. package/src/scripts/remove-smaller-files.js +500 -8
  244. package/src/scripts/rename-files-with-date.js +517 -9
  245. package/src/scripts/resize-image.js +523 -9
  246. package/src/scripts/rm-safe.js +653 -8
  247. package/src/scripts/s.js +525 -9
  248. package/src/scripts/set-git-public.js +349 -7
  249. package/src/scripts/show-desktop-icons.js +459 -7
  250. package/src/scripts/show-hidden-files.js +456 -7
  251. package/src/scripts/tpa.js +265 -8
  252. package/src/scripts/tpo.js +264 -7
  253. package/src/scripts/u.js +489 -7
  254. package/src/scripts/vpush.js +422 -8
  255. package/src/scripts/y.js +267 -7
  256. package/src/utils/common/os.js +94 -2
  257. package/src/utils/ubuntu/apt.js +13 -7
  258. package/src/utils/windows/choco.js +82 -26
  259. package/src/utils/windows/winget.js +89 -27
@@ -1,44 +1,719 @@
1
1
  #!/usr/bin/env node
2
2
 
3
3
  /**
4
- * @fileoverview Install Keyboard Maestro.
4
+ * @fileoverview Install Keyboard Maestro (macOS) or equivalent automation tools on other platforms.
5
5
  * @module installs/keyboard-maestro
6
+ *
7
+ * Keyboard Maestro is a powerful macro and automation application for macOS
8
+ * developed by Stairways Software. It enables users to automate virtually any
9
+ * task on their Mac by creating macros that can be triggered by hotkeys,
10
+ * typed strings, application launches, time schedules, and many other triggers.
11
+ *
12
+ * IMPORTANT PLATFORM LIMITATION:
13
+ * Keyboard Maestro is officially supported ONLY on macOS. There is NO version
14
+ * for Windows, Linux, or any other operating system. Stairways Software has
15
+ * no plans to create versions for other platforms.
16
+ *
17
+ * For other platforms, this installer installs platform-appropriate automation
18
+ * tools that provide similar functionality:
19
+ * - Windows: AutoHotkey (open-source scripting language for Windows automation)
20
+ * - Ubuntu/Debian/Raspberry Pi: AutoKey (desktop automation utility for Linux/X11)
21
+ * - Amazon Linux/RHEL: Not applicable (server OS without desktop environment)
22
+ *
23
+ * For unsupported platforms, this installer will display a simple message
24
+ * and return gracefully without error.
6
25
  */
7
26
 
8
27
  const os = require('../utils/common/os');
28
+ const shell = require('../utils/common/shell');
29
+ const brew = require('../utils/macos/brew');
30
+ const macosApps = require('../utils/macos/apps');
31
+ const apt = require('../utils/ubuntu/apt');
32
+ const choco = require('../utils/windows/choco');
33
+ const fs = require('fs');
34
+
35
+ /**
36
+ * Whether this installer requires a desktop environment to function.
37
+ * Keyboard Maestro is a GUI automation application.
38
+ */
39
+ const REQUIRES_DESKTOP = true;
40
+
41
+ /**
42
+ * The name of the application bundle on macOS.
43
+ * Keyboard Maestro installs to /Applications/Keyboard Maestro.app
44
+ */
45
+ const MACOS_APP_NAME = 'Keyboard Maestro';
46
+
47
+ /**
48
+ * The full path to the macOS application bundle.
49
+ */
50
+ const MACOS_APP_PATH = '/Applications/Keyboard Maestro.app';
51
+
52
+ /**
53
+ * The Homebrew cask name for Keyboard Maestro.
54
+ */
55
+ const HOMEBREW_CASK_NAME = 'keyboard-maestro';
56
+
57
+ /**
58
+ * The APT package name for AutoKey (GTK version) on Ubuntu/Debian/Raspberry Pi.
59
+ * The GTK version is recommended for most desktop environments.
60
+ */
61
+ const AUTOKEY_GTK_PACKAGE = 'autokey-gtk';
62
+
63
+ /**
64
+ * The Chocolatey package name for AutoHotkey on Windows.
65
+ */
66
+ const CHOCO_AUTOHOTKEY_PACKAGE = 'autohotkey';
67
+
68
+ /**
69
+ * Check if Keyboard Maestro is installed on macOS.
70
+ *
71
+ * We check for the application bundle directly at /Applications/Keyboard Maestro.app
72
+ * since this is the standard installation location for the Homebrew cask.
73
+ *
74
+ * @returns {boolean} True if Keyboard Maestro is installed, false otherwise
75
+ */
76
+ function isKeyboardMaestroInstalled() {
77
+ return fs.existsSync(MACOS_APP_PATH);
78
+ }
79
+
80
+ /**
81
+ * Check if AutoKey (GTK version) is installed on Linux.
82
+ *
83
+ * We check if the autokey-gtk command exists in the system PATH,
84
+ * which indicates that the autokey-gtk package has been installed.
85
+ *
86
+ * @returns {boolean} True if AutoKey GTK is installed, false otherwise
87
+ */
88
+ function isAutoKeyInstalled() {
89
+ return shell.commandExists('autokey-gtk');
90
+ }
91
+
92
+ /**
93
+ * Check if AutoHotkey is installed on Windows.
94
+ *
95
+ * We use the Chocolatey package manager to check if AutoHotkey
96
+ * has been installed via the choco install command.
97
+ *
98
+ * @returns {Promise<boolean>} True if AutoHotkey is installed, false otherwise
99
+ */
100
+ async function isAutoHotkeyInstalled() {
101
+ // First check if the AutoHotkey executable exists in common locations
102
+ const autohotkeyExists = shell.commandExists('AutoHotkey64.exe') ||
103
+ shell.commandExists('AutoHotkey.exe');
104
+ if (autohotkeyExists) {
105
+ return true;
106
+ }
107
+
108
+ // Fallback: check via Chocolatey if installed that way
109
+ if (choco.isInstalled()) {
110
+ return await choco.isPackageInstalled(CHOCO_AUTOHOTKEY_PACKAGE);
111
+ }
112
+
113
+ return false;
114
+ }
115
+
116
+ /**
117
+ * Install Keyboard Maestro on macOS using Homebrew.
118
+ *
119
+ * Prerequisites:
120
+ * - macOS 10.13 (High Sierra) or later (macOS 10.15 Catalina or later recommended)
121
+ * - Homebrew package manager installed
122
+ * - 64-bit processor (Intel or Apple Silicon natively supported)
123
+ * - Valid license for full functionality (trial available)
124
+ *
125
+ * The installation uses the Homebrew cask 'keyboard-maestro' which downloads
126
+ * and installs Keyboard Maestro to /Applications/Keyboard Maestro.app.
127
+ *
128
+ * NOTE: After installation, the user must:
129
+ * 1. Grant Accessibility permissions in System Settings > Privacy & Security
130
+ * 2. Optionally purchase a license (US$36) or use the trial version
131
+ *
132
+ * @returns {Promise<void>}
133
+ * @throws {Error} If Homebrew is not installed or installation fails
134
+ */
135
+ async function install_macos() {
136
+ console.log('Checking if Keyboard Maestro is already installed...');
137
+
138
+ // Check if already installed using direct path check
139
+ if (isKeyboardMaestroInstalled()) {
140
+ console.log('Keyboard Maestro is already installed, skipping installation.');
141
+ return;
142
+ }
143
+
144
+ // Verify Homebrew is available before attempting installation
145
+ if (!brew.isInstalled()) {
146
+ throw new Error(
147
+ 'Homebrew is not installed. Please install Homebrew first using:\n' +
148
+ ' dev install homebrew\n' +
149
+ 'Then retry installing Keyboard Maestro.'
150
+ );
151
+ }
152
+
153
+ console.log('Installing Keyboard Maestro via Homebrew...');
154
+
155
+ // Install the cask using the brew utility
156
+ // The cask installs the app to /Applications/Keyboard Maestro.app
157
+ const result = await brew.installCask(HOMEBREW_CASK_NAME);
158
+
159
+ if (!result.success) {
160
+ throw new Error(
161
+ `Failed to install Keyboard Maestro via Homebrew.\n` +
162
+ `Output: ${result.output}\n\n` +
163
+ `Troubleshooting:\n` +
164
+ ` 1. Run 'brew update && brew cleanup' and retry\n` +
165
+ ` 2. If you see permission errors, try 'brew reinstall --cask keyboard-maestro'\n` +
166
+ ` 3. If blocked by Gatekeeper, run: xattr -cr "/Applications/Keyboard Maestro.app"`
167
+ );
168
+ }
169
+
170
+ // Verify the installation succeeded by checking if the app exists
171
+ if (!isKeyboardMaestroInstalled()) {
172
+ throw new Error(
173
+ 'Installation appeared to complete but Keyboard Maestro was not found at:\n' +
174
+ ` ${MACOS_APP_PATH}\n\n` +
175
+ 'Please try reinstalling manually: brew reinstall --cask keyboard-maestro'
176
+ );
177
+ }
178
+
179
+ console.log('Keyboard Maestro installed successfully.');
180
+ console.log('');
181
+ console.log('IMPORTANT POST-INSTALLATION STEPS:');
182
+ console.log('1. Launch Keyboard Maestro from /Applications');
183
+ console.log('2. Grant Accessibility permissions when prompted:');
184
+ console.log(' System Settings > Privacy & Security > Accessibility');
185
+ console.log('3. Purchase a license (US$36) or use the trial version');
186
+ console.log('');
187
+ console.log('The Keyboard Maestro Engine must be running for macros to trigger.');
188
+ }
189
+
190
+ /**
191
+ * Install AutoKey on Ubuntu/Debian using APT.
192
+ *
193
+ * Since Keyboard Maestro is macOS-only, we install AutoKey as the
194
+ * equivalent automation tool for Linux. AutoKey is a desktop automation
195
+ * utility that provides text expansion and scripting capabilities.
196
+ *
197
+ * Prerequisites:
198
+ * - Ubuntu 20.04 LTS or later, or Debian 11 (Bullseye) or later
199
+ * - X11 display server (AutoKey does not work with Wayland)
200
+ * - sudo privileges
201
+ * - Desktop environment (GNOME, KDE, XFCE, etc.)
202
+ *
203
+ * @returns {Promise<void>}
204
+ * @throws {Error} If APT is not available or installation fails
205
+ */
206
+ async function install_ubuntu() {
207
+ console.log('Keyboard Maestro is macOS-only. Installing AutoKey as the Linux equivalent...');
208
+ console.log('');
209
+
210
+ // Check if already installed
211
+ if (isAutoKeyInstalled()) {
212
+ console.log('AutoKey is already installed, skipping installation.');
213
+ return;
214
+ }
215
+
216
+ // Verify APT is available
217
+ if (!apt.isInstalled()) {
218
+ throw new Error(
219
+ 'APT package manager is not available.\n' +
220
+ 'This installer requires a Debian-based system with apt-get.'
221
+ );
222
+ }
223
+
224
+ // Update package lists first to ensure we have the latest package info
225
+ console.log('Updating package lists...');
226
+ const updateResult = await apt.update();
227
+ if (!updateResult.success) {
228
+ console.log('Warning: Failed to update package lists, continuing with installation...');
229
+ }
230
+
231
+ // Install AutoKey GTK version (recommended for most desktop environments)
232
+ console.log('Installing AutoKey (GTK version) via APT...');
233
+ const installResult = await apt.install(AUTOKEY_GTK_PACKAGE);
234
+
235
+ if (!installResult.success) {
236
+ throw new Error(
237
+ `Failed to install AutoKey via APT.\n` +
238
+ `Output: ${installResult.output}\n\n` +
239
+ `Troubleshooting:\n` +
240
+ ` 1. Try: sudo add-apt-repository universe -y && sudo apt-get update\n` +
241
+ ` 2. For KDE/Qt desktops, try: sudo apt-get install autokey-qt\n` +
242
+ ` 3. Ensure you have a desktop environment installed (not headless/server)`
243
+ );
244
+ }
245
+
246
+ // Verify installation succeeded
247
+ if (!isAutoKeyInstalled()) {
248
+ throw new Error(
249
+ 'Installation appeared to complete but AutoKey was not found.\n\n' +
250
+ 'Please try installing manually:\n' +
251
+ ' sudo apt-get update && sudo apt-get install -y autokey-gtk'
252
+ );
253
+ }
254
+
255
+ console.log('AutoKey installed successfully.');
256
+ console.log('');
257
+ console.log('IMPORTANT NOTES:');
258
+ console.log('1. AutoKey requires X11 (does not work with Wayland)');
259
+ console.log('2. Check your display server: echo $XDG_SESSION_TYPE');
260
+ console.log('3. If using Wayland, log out and select "Ubuntu on Xorg" at login');
261
+ console.log('4. Launch AutoKey from your application menu or run: autokey-gtk');
262
+ }
263
+
264
+ /**
265
+ * Install AutoKey on Raspberry Pi OS using APT.
266
+ *
267
+ * Since Keyboard Maestro is macOS-only, we install AutoKey as the
268
+ * equivalent automation tool. The installation process is identical
269
+ * to Ubuntu/Debian since Raspberry Pi OS is Debian-based.
270
+ *
271
+ * Prerequisites:
272
+ * - Raspberry Pi OS (Bookworm or Bullseye) with desktop environment
273
+ * - Raspberry Pi 3 or later (earlier models have limited performance)
274
+ * - X11 display server (default on Raspberry Pi OS)
275
+ * - sudo privileges
276
+ *
277
+ * @returns {Promise<void>}
278
+ * @throws {Error} If APT is not available or installation fails
279
+ */
280
+ async function install_raspbian() {
281
+ console.log('Keyboard Maestro is macOS-only. Installing AutoKey as the Linux equivalent...');
282
+ console.log('');
283
+
284
+ // Check if already installed
285
+ if (isAutoKeyInstalled()) {
286
+ console.log('AutoKey is already installed, skipping installation.');
287
+ return;
288
+ }
289
+
290
+ // Verify APT is available
291
+ if (!apt.isInstalled()) {
292
+ throw new Error(
293
+ 'APT package manager is not available.\n' +
294
+ 'This installer requires Raspberry Pi OS with apt-get.'
295
+ );
296
+ }
297
+
298
+ // Update package lists first
299
+ console.log('Updating package lists...');
300
+ const updateResult = await apt.update();
301
+ if (!updateResult.success) {
302
+ console.log('Warning: Failed to update package lists, continuing with installation...');
303
+ }
304
+
305
+ // Install AutoKey GTK version (recommended for Raspberry Pi OS)
306
+ console.log('Installing AutoKey (GTK version) via APT...');
307
+ const installResult = await apt.install(AUTOKEY_GTK_PACKAGE);
308
+
309
+ if (!installResult.success) {
310
+ throw new Error(
311
+ `Failed to install AutoKey via APT.\n` +
312
+ `Output: ${installResult.output}\n\n` +
313
+ `Troubleshooting:\n` +
314
+ ` 1. Ensure you are using Raspberry Pi OS with desktop (not Lite)\n` +
315
+ ` 2. Try: sudo apt-get update && sudo apt-get install -y autokey-gtk\n` +
316
+ ` 3. Raspberry Pi 4 or 5 is recommended for better performance`
317
+ );
318
+ }
319
+
320
+ // Verify installation succeeded
321
+ if (!isAutoKeyInstalled()) {
322
+ throw new Error(
323
+ 'Installation appeared to complete but AutoKey was not found.\n\n' +
324
+ 'Please try installing manually:\n' +
325
+ ' sudo apt-get update && sudo apt-get install -y autokey-gtk'
326
+ );
327
+ }
328
+
329
+ console.log('AutoKey installed successfully.');
330
+ console.log('');
331
+ console.log('IMPORTANT NOTES:');
332
+ console.log('1. AutoKey requires a graphical desktop session (not SSH/headless)');
333
+ console.log('2. Verify X11 is running: echo $DISPLAY');
334
+ console.log('3. Launch AutoKey from your application menu or run: autokey-gtk');
335
+ console.log('4. AutoKey can be resource-intensive on Raspberry Pi 3');
336
+ }
337
+
338
+ /**
339
+ * Handle installation request for Amazon Linux/RHEL.
340
+ *
341
+ * Amazon Linux and RHEL are primarily server operating systems without
342
+ * desktop environments by default. Desktop automation tools like
343
+ * Keyboard Maestro or AutoKey are not applicable to these platforms
344
+ * in typical use cases.
345
+ *
346
+ * This function returns gracefully with a message rather than throwing
347
+ * an error, as per the installer guidelines.
348
+ *
349
+ * @returns {Promise<void>}
350
+ */
351
+ async function install_amazon_linux() {
352
+ console.log('Keyboard Maestro is not available for Amazon Linux/RHEL.');
353
+ console.log('');
354
+ console.log('Amazon Linux and RHEL are server operating systems that typically');
355
+ console.log('do not include desktop environments. For server automation, consider');
356
+ console.log('using shell scripts, cron jobs, or systemd timers instead.');
357
+ }
358
+
359
+ /**
360
+ * Install AutoHotkey on Windows using Chocolatey.
361
+ *
362
+ * Since Keyboard Maestro is macOS-only, we install AutoHotkey as the
363
+ * equivalent automation tool for Windows. AutoHotkey is an open-source
364
+ * scripting language that allows automation of the Windows GUI and
365
+ * general scripting.
366
+ *
367
+ * Prerequisites:
368
+ * - Windows 10 or later (64-bit recommended)
369
+ * - Chocolatey package manager installed
370
+ * - Administrator privileges
371
+ *
372
+ * @returns {Promise<void>}
373
+ * @throws {Error} If Chocolatey is not installed or installation fails
374
+ */
375
+ async function install_windows() {
376
+ console.log('Keyboard Maestro is macOS-only. Installing AutoHotkey as the Windows equivalent...');
377
+ console.log('');
378
+
379
+ // Check if already installed
380
+ const alreadyInstalled = await isAutoHotkeyInstalled();
381
+ if (alreadyInstalled) {
382
+ console.log('AutoHotkey is already installed, skipping installation.');
383
+ return;
384
+ }
385
+
386
+ // Verify Chocolatey is available
387
+ if (!choco.isInstalled()) {
388
+ throw new Error(
389
+ 'Chocolatey is not installed.\n\n' +
390
+ 'To install Chocolatey, open PowerShell as Administrator and run:\n' +
391
+ ' Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString(\'https://community.chocolatey.org/install.ps1\'))\n\n' +
392
+ 'Or run: dev install chocolatey\n\n' +
393
+ 'Then retry installing Keyboard Maestro.'
394
+ );
395
+ }
396
+
397
+ console.log('Installing AutoHotkey via Chocolatey...');
398
+
399
+ // Install AutoHotkey using Chocolatey
400
+ const result = await choco.install(CHOCO_AUTOHOTKEY_PACKAGE);
401
+
402
+ if (!result.success) {
403
+ throw new Error(
404
+ `Failed to install AutoHotkey via Chocolatey.\n` +
405
+ `Output: ${result.output}\n\n` +
406
+ `Troubleshooting:\n` +
407
+ ` 1. Ensure you are running as Administrator\n` +
408
+ ` 2. Try: choco install autohotkey -y --force\n` +
409
+ ` 3. If antivirus blocks it, add AutoHotkey to exclusions`
410
+ );
411
+ }
412
+
413
+ // Verify installation succeeded
414
+ const verified = await isAutoHotkeyInstalled();
415
+ if (!verified) {
416
+ // AutoHotkey might be installed but not in PATH yet - check via Chocolatey
417
+ const chocoCheck = await choco.isPackageInstalled(CHOCO_AUTOHOTKEY_PACKAGE);
418
+ if (!chocoCheck) {
419
+ throw new Error(
420
+ 'Installation appeared to complete but AutoHotkey was not found.\n\n' +
421
+ 'Please try installing manually:\n' +
422
+ ' choco install autohotkey -y'
423
+ );
424
+ }
425
+ console.log('AutoHotkey installed successfully (restart terminal to update PATH).');
426
+ } else {
427
+ console.log('AutoHotkey installed successfully.');
428
+ }
429
+
430
+ console.log('');
431
+ console.log('GETTING STARTED WITH AUTOHOTKEY:');
432
+ console.log('1. Create a .ahk script file with your automation rules');
433
+ console.log('2. Example hotkey: #n::Run "notepad.exe" (Win+N opens Notepad)');
434
+ console.log('3. Example text expansion: ::btw::by the way');
435
+ console.log('4. Place .ahk files in the Startup folder to run at login');
436
+ console.log('5. Documentation: https://www.autohotkey.com/docs/v2/');
437
+ }
438
+
439
+ /**
440
+ * Install automation tools from Ubuntu running in WSL (Windows Subsystem for Linux).
441
+ *
442
+ * Since Keyboard Maestro cannot run inside WSL (macOS-only), and AutoKey
443
+ * requires X11 which may not be configured in WSL, we install AutoHotkey
444
+ * on the Windows HOST instead. This is the most practical approach for
445
+ * automating tasks in a WSL environment.
446
+ *
447
+ * Prerequisites:
448
+ * - WSL 2 with Ubuntu installed
449
+ * - Chocolatey or winget on the Windows host
450
+ * - Administrator privileges on Windows
451
+ *
452
+ * @returns {Promise<void>}
453
+ * @throws {Error} If installation on Windows host fails
454
+ */
455
+ async function install_ubuntu_wsl() {
456
+ console.log('Detected Ubuntu running in WSL (Windows Subsystem for Linux).');
457
+ console.log('');
458
+ console.log('Keyboard Maestro is macOS-only and cannot run in WSL.');
459
+ console.log('Installing AutoHotkey on the Windows HOST instead...');
460
+ console.log('');
461
+
462
+ // Check if AutoHotkey is already installed on Windows host via PowerShell
463
+ console.log('Checking if AutoHotkey is already installed on Windows host...');
464
+
465
+ const checkResult = await shell.exec(
466
+ `powershell.exe -NoProfile -Command "Get-Command AutoHotkey64.exe -ErrorAction SilentlyContinue | Select-Object -ExpandProperty Source"`
467
+ );
468
+
469
+ if (checkResult.code === 0 && checkResult.stdout.trim()) {
470
+ console.log('AutoHotkey is already installed on the Windows host, skipping installation.');
471
+ console.log(`Location: ${checkResult.stdout.trim()}`);
472
+ return;
473
+ }
474
+
475
+ // Try to install via Chocolatey on Windows host
476
+ console.log('Installing AutoHotkey on Windows host via Chocolatey...');
477
+
478
+ const installResult = await shell.exec(
479
+ `powershell.exe -NoProfile -Command "choco install autohotkey -y"`
480
+ );
481
+
482
+ if (installResult.code !== 0) {
483
+ // Chocolatey might not be installed, try winget as fallback
484
+ console.log('Chocolatey installation failed, trying winget...');
485
+
486
+ const wingetResult = await shell.exec(
487
+ `powershell.exe -NoProfile -Command "winget install --id AutoHotkey.AutoHotkey --silent --accept-package-agreements --accept-source-agreements"`
488
+ );
489
+
490
+ if (wingetResult.code !== 0) {
491
+ throw new Error(
492
+ `Failed to install AutoHotkey on the Windows host.\n` +
493
+ `Chocolatey output: ${installResult.stdout || installResult.stderr}\n` +
494
+ `Winget output: ${wingetResult.stdout || wingetResult.stderr}\n\n` +
495
+ `Troubleshooting:\n` +
496
+ ` 1. Open PowerShell as Administrator on Windows and run:\n` +
497
+ ` choco install autohotkey -y\n` +
498
+ ` 2. Or install via winget:\n` +
499
+ ` winget install --id AutoHotkey.AutoHotkey --silent`
500
+ );
501
+ }
502
+ }
503
+
504
+ // Verify installation succeeded
505
+ const verifyResult = await shell.exec(
506
+ `powershell.exe -NoProfile -Command "Get-Command AutoHotkey64.exe -ErrorAction SilentlyContinue | Select-Object -ExpandProperty Source"`
507
+ );
508
+
509
+ if (verifyResult.code !== 0 || !verifyResult.stdout.trim()) {
510
+ // Installation might have succeeded but command not in PATH yet
511
+ console.log('AutoHotkey installed successfully on the Windows host.');
512
+ console.log('Note: You may need to restart your terminal for PATH to update.');
513
+ } else {
514
+ console.log('AutoHotkey installed successfully on the Windows host.');
515
+ console.log(`Location: ${verifyResult.stdout.trim()}`);
516
+ }
517
+
518
+ console.log('');
519
+ console.log('USING AUTOHOTKEY FROM WSL:');
520
+ console.log('1. Create .ahk scripts on the Windows host');
521
+ console.log('2. Access Windows files from WSL at /mnt/c/');
522
+ console.log('3. Run scripts via: powershell.exe -Command "AutoHotkey64.exe C:\\path\\to\\script.ahk"');
523
+ }
9
524
 
10
525
  /**
11
- * Install Keyboard Maestro across supported platforms.
526
+ * Install AutoHotkey from Git Bash on Windows.
527
+ *
528
+ * Git Bash runs within Windows, so this function installs AutoHotkey
529
+ * on the Windows host using Chocolatey via PowerShell interop.
530
+ *
531
+ * @returns {Promise<void>}
532
+ * @throws {Error} If Chocolatey is not available or installation fails
533
+ */
534
+ async function install_gitbash() {
535
+ console.log('Detected Git Bash on Windows.');
536
+ console.log('Keyboard Maestro is macOS-only. Installing AutoHotkey instead...');
537
+ console.log('');
538
+
539
+ // Check if AutoHotkey is already installed via PowerShell
540
+ console.log('Checking if AutoHotkey is already installed...');
541
+
542
+ const checkResult = await shell.exec(
543
+ `powershell.exe -NoProfile -Command "Get-Command AutoHotkey64.exe -ErrorAction SilentlyContinue | Select-Object -ExpandProperty Source"`
544
+ );
545
+
546
+ if (checkResult.code === 0 && checkResult.stdout.trim()) {
547
+ console.log('AutoHotkey is already installed, skipping installation.');
548
+ console.log(`Location: ${checkResult.stdout.trim()}`);
549
+ return;
550
+ }
551
+
552
+ // Install via Chocolatey
553
+ console.log('Installing AutoHotkey via Chocolatey...');
554
+
555
+ const installResult = await shell.exec(
556
+ `powershell.exe -NoProfile -Command "choco install autohotkey -y"`
557
+ );
558
+
559
+ if (installResult.code !== 0) {
560
+ // Try winget as fallback
561
+ console.log('Chocolatey installation failed, trying winget...');
562
+
563
+ const wingetResult = await shell.exec(
564
+ `powershell.exe -NoProfile -Command "winget install --id AutoHotkey.AutoHotkey --silent --accept-package-agreements --accept-source-agreements"`
565
+ );
566
+
567
+ if (wingetResult.code !== 0) {
568
+ throw new Error(
569
+ `Failed to install AutoHotkey.\n` +
570
+ `Output: ${installResult.stdout || installResult.stderr}\n\n` +
571
+ `Troubleshooting:\n` +
572
+ ` 1. Run Git Bash as Administrator and retry\n` +
573
+ ` 2. Or install manually from PowerShell:\n` +
574
+ ` choco install autohotkey -y`
575
+ );
576
+ }
577
+ }
578
+
579
+ // Verify installation
580
+ const verifyResult = await shell.exec(
581
+ `powershell.exe -NoProfile -Command "Get-Command AutoHotkey64.exe -ErrorAction SilentlyContinue | Select-Object -ExpandProperty Source"`
582
+ );
583
+
584
+ if (verifyResult.code === 0 && verifyResult.stdout.trim()) {
585
+ console.log('AutoHotkey installed successfully.');
586
+ console.log(`Location: ${verifyResult.stdout.trim()}`);
587
+ } else {
588
+ console.log('AutoHotkey installed successfully.');
589
+ console.log('Note: You may need to restart your terminal for PATH to update.');
590
+ }
591
+
592
+ console.log('');
593
+ console.log('GETTING STARTED WITH AUTOHOTKEY:');
594
+ console.log('1. Create a .ahk script file with your automation rules');
595
+ console.log('2. Example: #n::Run "notepad.exe" (Win+N opens Notepad)');
596
+ console.log('3. Place scripts in shell:startup to run at login');
597
+ console.log('4. Documentation: https://www.autohotkey.com/docs/v2/');
598
+ }
599
+
600
+ /**
601
+ * Check if Keyboard Maestro (or equivalent automation tool) is installed.
602
+ *
603
+ * On macOS, checks if Keyboard Maestro cask is installed via Homebrew.
604
+ * On Windows/Git Bash, checks if AutoHotkey is installed via Chocolatey.
605
+ * On Linux, checks if autokey-gtk command exists.
606
+ *
607
+ * @returns {Promise<boolean>} True if installed, false otherwise
608
+ */
609
+ async function isInstalled() {
610
+ const platform = os.detect();
611
+
612
+ if (platform.type === 'macos') {
613
+ return brew.isCaskInstalled(HOMEBREW_CASK_NAME);
614
+ }
615
+
616
+ if (platform.type === 'windows' || platform.type === 'gitbash') {
617
+ return choco.isPackageInstalled(CHOCO_AUTOHOTKEY_PACKAGE);
618
+ }
619
+
620
+ // Linux: Check if autokey-gtk command exists
621
+ if (['ubuntu', 'debian', 'raspbian', 'wsl'].includes(platform.type)) {
622
+ return shell.commandExists('autokey-gtk');
623
+ }
624
+
625
+ // Server platforms (amazon_linux, rhel, fedora) don't have automation tools
626
+ return false;
627
+ }
628
+
629
+ /**
630
+ * Check if this installer is supported on the current platform.
631
+ * Keyboard Maestro (or equivalent) is supported on desktop platforms.
632
+ * Server operating systems (Amazon Linux, RHEL, Fedora) are NOT supported.
633
+ * @returns {boolean} True if installation is supported on this platform
634
+ */
635
+ function isEligible() {
636
+ const platform = os.detect();
637
+ // Desktop automation tools are NOT applicable to server operating systems
638
+ const supportedPlatforms = ['macos', 'ubuntu', 'debian', 'wsl', 'raspbian', 'windows', 'gitbash'];
639
+ if (!supportedPlatforms.includes(platform.type)) {
640
+ return false;
641
+ }
642
+ if (REQUIRES_DESKTOP && !os.isDesktopAvailable()) {
643
+ return false;
644
+ }
645
+ return true;
646
+ }
647
+
648
+ /**
649
+ * Main installation entry point.
650
+ *
651
+ * Detects the current platform and runs the appropriate installer function.
652
+ * Handles platform-specific mappings to ensure all supported (and unsupported)
653
+ * platforms have appropriate installation logic.
654
+ *
655
+ * Supported platforms and what gets installed:
656
+ * - macOS: Keyboard Maestro via Homebrew cask
657
+ * - Windows: AutoHotkey via Chocolatey
658
+ * - Git Bash: AutoHotkey via PowerShell/Chocolatey
659
+ * - WSL (Ubuntu): AutoHotkey on Windows host via PowerShell
660
+ * - Ubuntu/Debian: AutoKey via APT
661
+ * - Raspberry Pi OS: AutoKey via APT
662
+ *
663
+ * Unsupported platforms (returns gracefully with message):
664
+ * - Amazon Linux/RHEL: Server OS, desktop automation not applicable
12
665
  *
13
666
  * @returns {Promise<void>}
14
667
  */
15
668
  async function install() {
16
669
  const platform = os.detect();
17
670
 
18
- switch (platform.type) {
19
- case 'macos':
20
- // TODO: Implement macOS installation
21
- break;
22
- case 'debian':
23
- // TODO: Implement Debian/Ubuntu installation
24
- break;
25
- case 'rhel':
26
- // TODO: Implement RHEL/Amazon Linux installation
27
- break;
28
- case 'windows-wsl':
29
- // TODO: Implement WSL installation
30
- break;
31
- case 'windows':
32
- // TODO: Implement Windows installation
33
- break;
34
- default:
35
- console.error(`Unsupported platform: ${platform.type}`);
36
- process.exit(1);
37
- }
38
- }
39
-
40
- module.exports = { install };
671
+ // Map platform types to their installer functions
672
+ // This mapping handles aliases (e.g., debian maps to ubuntu)
673
+ const installers = {
674
+ 'macos': install_macos,
675
+ 'ubuntu': install_ubuntu,
676
+ 'debian': install_ubuntu,
677
+ 'ubuntu-wsl': install_ubuntu_wsl,
678
+ 'wsl': install_ubuntu_wsl,
679
+ 'raspbian': install_raspbian,
680
+ 'amazon_linux': install_amazon_linux,
681
+ 'amazon-linux': install_amazon_linux,
682
+ 'rhel': install_amazon_linux,
683
+ 'fedora': install_amazon_linux,
684
+ 'windows': install_windows,
685
+ 'gitbash': install_gitbash
686
+ };
687
+
688
+ const installer = installers[platform.type];
689
+
690
+ if (!installer) {
691
+ console.log(`Keyboard Maestro is not available for ${platform.type}.`);
692
+ return;
693
+ }
694
+
695
+ await installer();
696
+ }
697
+
698
+ // Export all functions for use as a module and for testing
699
+ module.exports = {
700
+ REQUIRES_DESKTOP,
701
+ install,
702
+ isInstalled,
703
+ isEligible,
704
+ install_macos,
705
+ install_ubuntu,
706
+ install_ubuntu_wsl,
707
+ install_raspbian,
708
+ install_amazon_linux,
709
+ install_windows,
710
+ install_gitbash
711
+ };
41
712
 
713
+ // Allow direct execution: node keyboard-maestro.js
42
714
  if (require.main === module) {
43
- install();
715
+ install().catch(err => {
716
+ console.error(err.message);
717
+ process.exit(1);
718
+ });
44
719
  }