@fredlackey/devutils 0.0.18 → 0.1.0

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 (447) hide show
  1. package/README.md +214 -141
  2. package/package.json +8 -83
  3. package/src/api/loader.js +229 -0
  4. package/src/api/registry.json +62 -0
  5. package/src/cli.js +293 -60
  6. package/src/commands/ai/index.js +16 -0
  7. package/src/commands/ai/launch.js +112 -0
  8. package/src/commands/ai/list.js +54 -0
  9. package/src/commands/ai/resume.js +70 -0
  10. package/src/commands/ai/sessions.js +121 -0
  11. package/src/commands/ai/set.js +131 -0
  12. package/src/commands/ai/show.js +74 -0
  13. package/src/commands/ai/tools.js +46 -0
  14. package/src/commands/alias/add.js +93 -0
  15. package/src/commands/alias/helpers.js +107 -0
  16. package/src/commands/alias/index.js +14 -0
  17. package/src/commands/alias/list.js +55 -0
  18. package/src/commands/alias/remove.js +62 -0
  19. package/src/commands/alias/sync.js +109 -0
  20. package/src/commands/api/disable.js +73 -0
  21. package/src/commands/api/enable.js +148 -0
  22. package/src/commands/api/index.js +15 -0
  23. package/src/commands/api/list.js +66 -0
  24. package/src/commands/api/update.js +87 -0
  25. package/src/commands/auth/index.js +15 -0
  26. package/src/commands/auth/list.js +49 -0
  27. package/src/commands/auth/login.js +384 -0
  28. package/src/commands/auth/logout.js +111 -0
  29. package/src/commands/auth/refresh.js +184 -0
  30. package/src/commands/auth/services.js +169 -0
  31. package/src/commands/auth/status.js +104 -0
  32. package/src/commands/config/export.js +224 -0
  33. package/src/commands/config/get.js +52 -0
  34. package/src/commands/config/import.js +308 -0
  35. package/src/commands/config/index.js +17 -0
  36. package/src/commands/config/init.js +143 -0
  37. package/src/commands/config/reset.js +57 -0
  38. package/src/commands/config/set.js +93 -0
  39. package/src/commands/config/show.js +35 -0
  40. package/src/commands/help.js +338 -0
  41. package/src/commands/identity/add.js +133 -0
  42. package/src/commands/identity/index.js +17 -0
  43. package/src/commands/identity/link.js +76 -0
  44. package/src/commands/identity/list.js +48 -0
  45. package/src/commands/identity/remove.js +72 -0
  46. package/src/commands/identity/show.js +65 -0
  47. package/src/commands/identity/sync.js +172 -0
  48. package/src/commands/identity/unlink.js +57 -0
  49. package/src/commands/ignore/add.js +165 -0
  50. package/src/commands/ignore/index.js +14 -0
  51. package/src/commands/ignore/list.js +89 -0
  52. package/src/commands/ignore/markers.js +43 -0
  53. package/src/commands/ignore/remove.js +164 -0
  54. package/src/commands/ignore/show.js +169 -0
  55. package/src/commands/machine/detect.js +122 -0
  56. package/src/commands/machine/index.js +14 -0
  57. package/src/commands/machine/list.js +74 -0
  58. package/src/commands/machine/set.js +106 -0
  59. package/src/commands/machine/show.js +35 -0
  60. package/src/commands/schema.js +152 -0
  61. package/src/commands/search/collections.js +134 -0
  62. package/src/commands/search/get.js +71 -0
  63. package/src/commands/search/index-cmd.js +54 -0
  64. package/src/commands/search/index.js +21 -0
  65. package/src/commands/search/keyword.js +60 -0
  66. package/src/commands/search/qmd.js +70 -0
  67. package/src/commands/search/query.js +64 -0
  68. package/src/commands/search/semantic.js +62 -0
  69. package/src/commands/search/status.js +46 -0
  70. package/src/commands/status.js +224 -171
  71. package/src/commands/tools/check.js +79 -0
  72. package/src/commands/tools/index.js +14 -0
  73. package/src/commands/tools/install.js +110 -0
  74. package/src/commands/tools/list.js +91 -0
  75. package/src/commands/tools/search.js +60 -0
  76. package/src/commands/update.js +83 -112
  77. package/src/commands/util/add.js +151 -0
  78. package/src/commands/util/index.js +15 -0
  79. package/src/commands/util/list.js +97 -0
  80. package/src/commands/util/remove.js +76 -0
  81. package/src/commands/util/run.js +79 -0
  82. package/src/commands/util/show.js +67 -0
  83. package/src/commands/version.js +21 -88
  84. package/src/installers/_template.js +104 -0
  85. package/src/installers/git.js +150 -0
  86. package/src/installers/homebrew.js +190 -0
  87. package/src/installers/node.js +223 -0
  88. package/src/installers/registry.json +29 -0
  89. package/src/lib/config.js +125 -0
  90. package/src/lib/detect.js +74 -0
  91. package/src/lib/errors.js +114 -0
  92. package/src/lib/github.js +315 -0
  93. package/src/lib/installer.js +225 -0
  94. package/src/lib/output.js +239 -0
  95. package/src/lib/platform.js +112 -0
  96. package/src/lib/platforms/amazon-linux.js +41 -0
  97. package/src/lib/platforms/gitbash.js +46 -0
  98. package/src/lib/platforms/macos.js +45 -0
  99. package/src/lib/platforms/raspbian.js +41 -0
  100. package/src/lib/platforms/ubuntu.js +39 -0
  101. package/src/lib/platforms/windows.js +45 -0
  102. package/src/lib/prompt.js +161 -0
  103. package/src/lib/schema.js +211 -0
  104. package/src/lib/shell.js +75 -0
  105. package/src/patterns/gitignore/claude-code.txt +25 -0
  106. package/src/patterns/gitignore/docker.txt +15 -0
  107. package/src/patterns/gitignore/go.txt +24 -0
  108. package/src/patterns/gitignore/java.txt +38 -0
  109. package/src/patterns/gitignore/jetbrains.txt +26 -0
  110. package/src/patterns/gitignore/linux.txt +18 -0
  111. package/src/patterns/gitignore/macos.txt +27 -0
  112. package/src/patterns/gitignore/node.txt +51 -0
  113. package/src/patterns/gitignore/python.txt +55 -0
  114. package/src/patterns/gitignore/rust.txt +14 -0
  115. package/src/patterns/gitignore/terraform.txt +30 -0
  116. package/src/patterns/gitignore/vscode.txt +15 -0
  117. package/src/patterns/gitignore/windows.txt +25 -0
  118. package/src/utils/clone/index.js +165 -0
  119. package/src/utils/git-push/index.js +230 -0
  120. package/src/utils/git-status/index.js +116 -0
  121. package/src/utils/git-status/unix.sh +75 -0
  122. package/src/utils/registry.json +41 -0
  123. package/bin/dev.js +0 -16
  124. package/files/README.md +0 -0
  125. package/files/claude/.claude/commands/setup-context.md +0 -3
  126. package/files/monorepos/_archive/README.md +0 -36
  127. package/files/monorepos/_legacy/README.md +0 -36
  128. package/files/monorepos/ai-docs/README.md +0 -33
  129. package/files/monorepos/apps/README.md +0 -24
  130. package/files/monorepos/docs/README.md +0 -40
  131. package/files/monorepos/packages/README.md +0 -25
  132. package/files/monorepos/research/README.md +0 -29
  133. package/files/monorepos/scripts/README.md +0 -24
  134. package/src/commands/README.md +0 -41
  135. package/src/commands/configure.js +0 -199
  136. package/src/commands/identity.js +0 -1630
  137. package/src/commands/ignore.js +0 -247
  138. package/src/commands/install.js +0 -526
  139. package/src/commands/setup.js +0 -246
  140. package/src/completion.js +0 -284
  141. package/src/constants.js +0 -45
  142. package/src/ignore/claude-code.txt +0 -10
  143. package/src/ignore/docker.txt +0 -18
  144. package/src/ignore/linux.txt +0 -23
  145. package/src/ignore/macos.txt +0 -36
  146. package/src/ignore/node.txt +0 -55
  147. package/src/ignore/terraform.txt +0 -37
  148. package/src/ignore/vscode.txt +0 -18
  149. package/src/ignore/windows.txt +0 -35
  150. package/src/index.js +0 -0
  151. package/src/installs/README.md +0 -399
  152. package/src/installs/adobe-creative-cloud.js +0 -546
  153. package/src/installs/adobe-creative-cloud.md +0 -605
  154. package/src/installs/appcleaner.js +0 -321
  155. package/src/installs/appcleaner.md +0 -699
  156. package/src/installs/apt-transport-https.js +0 -390
  157. package/src/installs/apt-transport-https.md +0 -678
  158. package/src/installs/atomicparsley.js +0 -642
  159. package/src/installs/atomicparsley.md +0 -795
  160. package/src/installs/aws-cli.js +0 -797
  161. package/src/installs/aws-cli.md +0 -727
  162. package/src/installs/balena-etcher.js +0 -710
  163. package/src/installs/balena-etcher.md +0 -761
  164. package/src/installs/bambu-studio.js +0 -1143
  165. package/src/installs/bambu-studio.md +0 -780
  166. package/src/installs/bash-completion.js +0 -575
  167. package/src/installs/bash-completion.md +0 -833
  168. package/src/installs/bash.js +0 -417
  169. package/src/installs/bash.md +0 -993
  170. package/src/installs/beyond-compare.js +0 -603
  171. package/src/installs/beyond-compare.md +0 -813
  172. package/src/installs/brave-browser.js +0 -968
  173. package/src/installs/brave-browser.md +0 -650
  174. package/src/installs/build-essential.js +0 -529
  175. package/src/installs/build-essential.md +0 -977
  176. package/src/installs/ca-certificates.js +0 -618
  177. package/src/installs/ca-certificates.md +0 -937
  178. package/src/installs/caffeine.js +0 -508
  179. package/src/installs/caffeine.md +0 -839
  180. package/src/installs/camtasia.js +0 -596
  181. package/src/installs/camtasia.md +0 -762
  182. package/src/installs/chatgpt.js +0 -476
  183. package/src/installs/chatgpt.md +0 -814
  184. package/src/installs/chocolatey.js +0 -456
  185. package/src/installs/chocolatey.md +0 -661
  186. package/src/installs/chrome-canary.js +0 -419
  187. package/src/installs/chrome-canary.md +0 -641
  188. package/src/installs/chromium.js +0 -667
  189. package/src/installs/chromium.md +0 -838
  190. package/src/installs/claude-code.js +0 -576
  191. package/src/installs/claude-code.md +0 -1173
  192. package/src/installs/cloudflare-warp.js +0 -900
  193. package/src/installs/cloudflare-warp.md +0 -1047
  194. package/src/installs/comet-browser.js +0 -588
  195. package/src/installs/comet-browser.md +0 -731
  196. package/src/installs/curl.js +0 -379
  197. package/src/installs/curl.md +0 -714
  198. package/src/installs/cursor.js +0 -579
  199. package/src/installs/cursor.md +0 -970
  200. package/src/installs/dbeaver.js +0 -924
  201. package/src/installs/dbeaver.md +0 -939
  202. package/src/installs/dbschema.js +0 -692
  203. package/src/installs/dbschema.md +0 -925
  204. package/src/installs/dependencies.md +0 -453
  205. package/src/installs/development-tools.js +0 -600
  206. package/src/installs/development-tools.md +0 -977
  207. package/src/installs/docker.js +0 -1029
  208. package/src/installs/docker.md +0 -1109
  209. package/src/installs/drawio.js +0 -1019
  210. package/src/installs/drawio.md +0 -795
  211. package/src/installs/elmedia-player.js +0 -347
  212. package/src/installs/elmedia-player.md +0 -556
  213. package/src/installs/ffmpeg.js +0 -889
  214. package/src/installs/ffmpeg.md +0 -852
  215. package/src/installs/file.js +0 -464
  216. package/src/installs/file.md +0 -987
  217. package/src/installs/gemini-cli.js +0 -811
  218. package/src/installs/gemini-cli.md +0 -1153
  219. package/src/installs/git.js +0 -400
  220. package/src/installs/git.md +0 -907
  221. package/src/installs/gitego.js +0 -949
  222. package/src/installs/gitego.md +0 -1172
  223. package/src/installs/go.js +0 -931
  224. package/src/installs/go.md +0 -958
  225. package/src/installs/google-antigravity.js +0 -913
  226. package/src/installs/google-antigravity.md +0 -1075
  227. package/src/installs/google-chrome.js +0 -833
  228. package/src/installs/google-chrome.md +0 -862
  229. package/src/installs/gpg.js +0 -480
  230. package/src/installs/gpg.md +0 -1056
  231. package/src/installs/homebrew.js +0 -1028
  232. package/src/installs/homebrew.md +0 -988
  233. package/src/installs/imageoptim.js +0 -968
  234. package/src/installs/imageoptim.md +0 -1119
  235. package/src/installs/installers.json +0 -4032
  236. package/src/installs/installers.json.tmp +0 -3953
  237. package/src/installs/jq.js +0 -400
  238. package/src/installs/jq.md +0 -809
  239. package/src/installs/keyboard-maestro.js +0 -719
  240. package/src/installs/keyboard-maestro.md +0 -825
  241. package/src/installs/kiro.js +0 -864
  242. package/src/installs/kiro.md +0 -1015
  243. package/src/installs/latex.js +0 -789
  244. package/src/installs/latex.md +0 -1095
  245. package/src/installs/lftp.js +0 -356
  246. package/src/installs/lftp.md +0 -907
  247. package/src/installs/lsb-release.js +0 -346
  248. package/src/installs/lsb-release.md +0 -814
  249. package/src/installs/messenger.js +0 -847
  250. package/src/installs/messenger.md +0 -900
  251. package/src/installs/microsoft-office.js +0 -568
  252. package/src/installs/microsoft-office.md +0 -760
  253. package/src/installs/microsoft-teams.js +0 -801
  254. package/src/installs/microsoft-teams.md +0 -886
  255. package/src/installs/moom.js +0 -326
  256. package/src/installs/moom.md +0 -570
  257. package/src/installs/node.js +0 -904
  258. package/src/installs/node.md +0 -1153
  259. package/src/installs/nordpass.js +0 -716
  260. package/src/installs/nordpass.md +0 -921
  261. package/src/installs/nordvpn.js +0 -892
  262. package/src/installs/nordvpn.md +0 -1052
  263. package/src/installs/nvm.js +0 -995
  264. package/src/installs/nvm.md +0 -1057
  265. package/src/installs/ohmyzsh.js +0 -529
  266. package/src/installs/ohmyzsh.md +0 -1094
  267. package/src/installs/openssh.js +0 -804
  268. package/src/installs/openssh.md +0 -1056
  269. package/src/installs/pandoc.js +0 -662
  270. package/src/installs/pandoc.md +0 -1036
  271. package/src/installs/parallels-desktop.js +0 -431
  272. package/src/installs/parallels-desktop.md +0 -446
  273. package/src/installs/pinentry.js +0 -510
  274. package/src/installs/pinentry.md +0 -1142
  275. package/src/installs/pngyu.js +0 -869
  276. package/src/installs/pngyu.md +0 -896
  277. package/src/installs/postman.js +0 -799
  278. package/src/installs/postman.md +0 -940
  279. package/src/installs/procps.js +0 -425
  280. package/src/installs/procps.md +0 -851
  281. package/src/installs/safari-tech-preview.js +0 -374
  282. package/src/installs/safari-tech-preview.md +0 -533
  283. package/src/installs/sfnt2woff.js +0 -658
  284. package/src/installs/sfnt2woff.md +0 -795
  285. package/src/installs/shellcheck.js +0 -481
  286. package/src/installs/shellcheck.md +0 -1005
  287. package/src/installs/slack.js +0 -741
  288. package/src/installs/slack.md +0 -865
  289. package/src/installs/snagit.js +0 -585
  290. package/src/installs/snagit.md +0 -844
  291. package/src/installs/software-properties-common.js +0 -372
  292. package/src/installs/software-properties-common.md +0 -805
  293. package/src/installs/spotify.js +0 -877
  294. package/src/installs/spotify.md +0 -901
  295. package/src/installs/studio-3t.js +0 -823
  296. package/src/installs/studio-3t.md +0 -918
  297. package/src/installs/sublime-text.js +0 -804
  298. package/src/installs/sublime-text.md +0 -914
  299. package/src/installs/superwhisper.js +0 -706
  300. package/src/installs/superwhisper.md +0 -630
  301. package/src/installs/tailscale.js +0 -745
  302. package/src/installs/tailscale.md +0 -1100
  303. package/src/installs/tar.js +0 -389
  304. package/src/installs/tar.md +0 -946
  305. package/src/installs/termius.js +0 -798
  306. package/src/installs/termius.md +0 -844
  307. package/src/installs/terraform.js +0 -779
  308. package/src/installs/terraform.md +0 -899
  309. package/src/installs/tfenv.js +0 -778
  310. package/src/installs/tfenv.md +0 -1091
  311. package/src/installs/tidal.js +0 -771
  312. package/src/installs/tidal.md +0 -864
  313. package/src/installs/tmux.js +0 -346
  314. package/src/installs/tmux.md +0 -1030
  315. package/src/installs/tree.js +0 -411
  316. package/src/installs/tree.md +0 -833
  317. package/src/installs/unzip.js +0 -460
  318. package/src/installs/unzip.md +0 -879
  319. package/src/installs/vim.js +0 -421
  320. package/src/installs/vim.md +0 -1040
  321. package/src/installs/vlc.js +0 -821
  322. package/src/installs/vlc.md +0 -927
  323. package/src/installs/vscode.js +0 -843
  324. package/src/installs/vscode.md +0 -1002
  325. package/src/installs/wget.js +0 -420
  326. package/src/installs/wget.md +0 -791
  327. package/src/installs/whatsapp.js +0 -729
  328. package/src/installs/whatsapp.md +0 -854
  329. package/src/installs/winpty.js +0 -352
  330. package/src/installs/winpty.md +0 -620
  331. package/src/installs/woff2.js +0 -553
  332. package/src/installs/woff2.md +0 -977
  333. package/src/installs/wsl.js +0 -572
  334. package/src/installs/wsl.md +0 -699
  335. package/src/installs/xcode-clt.js +0 -520
  336. package/src/installs/xcode-clt.md +0 -351
  337. package/src/installs/xcode.js +0 -560
  338. package/src/installs/xcode.md +0 -573
  339. package/src/installs/yarn.js +0 -824
  340. package/src/installs/yarn.md +0 -1074
  341. package/src/installs/yq.js +0 -654
  342. package/src/installs/yq.md +0 -944
  343. package/src/installs/yt-dlp.js +0 -701
  344. package/src/installs/yt-dlp.md +0 -946
  345. package/src/installs/yum-utils.js +0 -297
  346. package/src/installs/yum-utils.md +0 -648
  347. package/src/installs/zoom.js +0 -759
  348. package/src/installs/zoom.md +0 -884
  349. package/src/installs/zsh.js +0 -455
  350. package/src/installs/zsh.md +0 -1008
  351. package/src/scripts/README.md +0 -617
  352. package/src/scripts/STATUS.md +0 -208
  353. package/src/scripts/afk.js +0 -411
  354. package/src/scripts/backup-all.js +0 -746
  355. package/src/scripts/backup-source.js +0 -727
  356. package/src/scripts/brewd.js +0 -389
  357. package/src/scripts/brewi.js +0 -520
  358. package/src/scripts/brewr.js +0 -527
  359. package/src/scripts/brews.js +0 -477
  360. package/src/scripts/brewu.js +0 -504
  361. package/src/scripts/c.js +0 -201
  362. package/src/scripts/ccurl.js +0 -341
  363. package/src/scripts/certbot-crontab-init.js +0 -504
  364. package/src/scripts/certbot-init.js +0 -657
  365. package/src/scripts/ch.js +0 -355
  366. package/src/scripts/claude-danger.js +0 -268
  367. package/src/scripts/clean-dev.js +0 -435
  368. package/src/scripts/clear-dns-cache.js +0 -541
  369. package/src/scripts/clone.js +0 -435
  370. package/src/scripts/code-all.js +0 -437
  371. package/src/scripts/count-files.js +0 -211
  372. package/src/scripts/count-folders.js +0 -211
  373. package/src/scripts/count.js +0 -264
  374. package/src/scripts/d.js +0 -219
  375. package/src/scripts/datauri.js +0 -389
  376. package/src/scripts/delete-files.js +0 -380
  377. package/src/scripts/docker-clean.js +0 -426
  378. package/src/scripts/dp.js +0 -442
  379. package/src/scripts/e.js +0 -390
  380. package/src/scripts/empty-trash.js +0 -513
  381. package/src/scripts/evm.js +0 -444
  382. package/src/scripts/fetch-github-repos.js +0 -456
  383. package/src/scripts/get-channel.js +0 -345
  384. package/src/scripts/get-course.js +0 -399
  385. package/src/scripts/get-dependencies.js +0 -306
  386. package/src/scripts/get-folder.js +0 -799
  387. package/src/scripts/get-tunes.js +0 -426
  388. package/src/scripts/get-video.js +0 -367
  389. package/src/scripts/git-backup.js +0 -577
  390. package/src/scripts/git-clone.js +0 -493
  391. package/src/scripts/git-pup.js +0 -319
  392. package/src/scripts/git-push.js +0 -396
  393. package/src/scripts/h.js +0 -622
  394. package/src/scripts/hide-desktop-icons.js +0 -499
  395. package/src/scripts/hide-hidden-files.js +0 -538
  396. package/src/scripts/install-dependencies-from.js +0 -456
  397. package/src/scripts/ips.js +0 -663
  398. package/src/scripts/iso.js +0 -370
  399. package/src/scripts/killni.js +0 -577
  400. package/src/scripts/ll.js +0 -467
  401. package/src/scripts/local-ip.js +0 -325
  402. package/src/scripts/m.js +0 -524
  403. package/src/scripts/map.js +0 -309
  404. package/src/scripts/mkd.js +0 -351
  405. package/src/scripts/ncu-update-all.js +0 -457
  406. package/src/scripts/nginx-init.js +0 -718
  407. package/src/scripts/npmi.js +0 -382
  408. package/src/scripts/o.js +0 -511
  409. package/src/scripts/org-by-date.js +0 -338
  410. package/src/scripts/p.js +0 -224
  411. package/src/scripts/packages.js +0 -330
  412. package/src/scripts/path.js +0 -225
  413. package/src/scripts/ports.js +0 -597
  414. package/src/scripts/q.js +0 -305
  415. package/src/scripts/refresh-files.js +0 -394
  416. package/src/scripts/remove-smaller-files.js +0 -516
  417. package/src/scripts/rename-files-with-date.js +0 -533
  418. package/src/scripts/resize-image.js +0 -539
  419. package/src/scripts/rm-safe.js +0 -669
  420. package/src/scripts/s.js +0 -540
  421. package/src/scripts/set-git-public.js +0 -365
  422. package/src/scripts/show-desktop-icons.js +0 -475
  423. package/src/scripts/show-hidden-files.js +0 -472
  424. package/src/scripts/tpa.js +0 -280
  425. package/src/scripts/tpo.js +0 -280
  426. package/src/scripts/u.js +0 -505
  427. package/src/scripts/vpush.js +0 -437
  428. package/src/scripts/y.js +0 -283
  429. package/src/utils/README.md +0 -95
  430. package/src/utils/common/apps.js +0 -143
  431. package/src/utils/common/display.js +0 -157
  432. package/src/utils/common/network.js +0 -185
  433. package/src/utils/common/os.js +0 -294
  434. package/src/utils/common/package-manager.js +0 -301
  435. package/src/utils/common/privileges.js +0 -138
  436. package/src/utils/common/shell.js +0 -261
  437. package/src/utils/macos/apps.js +0 -228
  438. package/src/utils/macos/brew.js +0 -315
  439. package/src/utils/ubuntu/apt.js +0 -307
  440. package/src/utils/ubuntu/desktop.js +0 -292
  441. package/src/utils/ubuntu/snap.js +0 -344
  442. package/src/utils/ubuntu/systemd.js +0 -286
  443. package/src/utils/windows/choco.js +0 -465
  444. package/src/utils/windows/env.js +0 -246
  445. package/src/utils/windows/registry.js +0 -269
  446. package/src/utils/windows/shell.js +0 -240
  447. package/src/utils/windows/winget.js +0 -489
@@ -1,944 +0,0 @@
1
- # Installing yq
2
-
3
- ## Overview
4
-
5
- yq is a lightweight and portable command-line YAML processor written in Go by Mike Farah. It uses jq-like syntax but works with YAML files as well as JSON, XML, CSV, TSV, INI, properties, and HCL formats. Think of yq as the jq or sed equivalent for YAML data - it allows you to read, filter, update, and transform structured data with concise expressions.
6
-
7
- ## Dependencies
8
-
9
- ### macOS (Homebrew)
10
- - **Required:**
11
- - Homebrew - Install via `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"` or run `dev install homebrew`
12
- - **Optional:** None
13
- - **Auto-installed:** None
14
-
15
- ### Ubuntu (APT/Snap)
16
- - **Required:**
17
- - snapd - Install via `sudo apt-get install snapd` (installer will attempt to install automatically if missing)
18
- - sudo privileges for package installation
19
- - **Optional:** None
20
- - **Auto-installed:**
21
- - snapd - Automatically installed via `sudo DEBIAN_FRONTEND=noninteractive apt-get update -y && sudo DEBIAN_FRONTEND=noninteractive apt-get install -y snapd` if not present
22
-
23
- ### Raspberry Pi OS (APT/Snap)
24
- - **Required:**
25
- - curl - Install via `sudo apt-get install curl` (typically pre-installed)
26
- - uname - Pre-installed system utility for architecture detection
27
- - sudo privileges for installation
28
- - **Optional:**
29
- - snapd - Install via `sudo apt-get install snapd` (preferred for 64-bit installations, installer falls back to binary download if unavailable)
30
- - **Auto-installed:** None
31
-
32
- ### Amazon Linux (DNF/YUM)
33
- - **Required:**
34
- - curl - Pre-installed on Amazon Linux (if missing: `sudo dnf install curl` or `sudo yum install curl`)
35
- - uname - Pre-installed system utility for architecture detection
36
- - sudo privileges for installation
37
- - **Optional:** None
38
- - **Auto-installed:** None
39
-
40
- ### Windows (Chocolatey/winget)
41
- - **Required:**
42
- - Chocolatey - Install via PowerShell: `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'))` or run `dev install chocolatey`
43
- - Administrator privileges (run PowerShell or Command Prompt as Administrator)
44
- - **Optional:**
45
- - winget - Pre-installed on Windows 11 and recent Windows 10 builds (alternative to Chocolatey)
46
- - **Auto-installed:** None
47
-
48
- ### Git Bash (Manual/Portable)
49
- - **Required:**
50
- - curl - Pre-installed with Git for Windows
51
- - mkdir - Pre-installed shell command
52
- - Git for Windows - Install from https://git-scm.com/download/win
53
- - **Optional:** None
54
- - **Auto-installed:** None
55
-
56
- yq is essential for developers and DevOps engineers who work with Kubernetes manifests, Helm charts, Docker Compose files, CI/CD configurations, or any YAML-based infrastructure. Common use cases include:
57
-
58
- - Parsing and extracting values from YAML configuration files
59
- - Modifying Kubernetes manifests programmatically
60
- - Converting between YAML, JSON, and XML formats
61
- - Merging multiple YAML files
62
- - Updating values in Docker Compose files
63
- - Processing CI/CD pipeline configurations
64
-
65
- yq is a single statically compiled binary with zero runtime dependencies, making it extremely portable and easy to deploy across platforms.
66
-
67
- **Important Note**: There are multiple tools named "yq" in the ecosystem. This documentation covers Mike Farah's Go-based yq (https://github.com/mikefarah/yq), which is the most widely used implementation. The Python-based yq (kislyuk/yq) available in some Linux package managers is a different tool.
68
-
69
- ## Prerequisites
70
-
71
- Before installing yq on any platform, ensure:
72
-
73
- 1. **Internet connectivity** - Required to download packages
74
- 2. **Administrative privileges** - Required on most platforms for system-wide installation
75
- 3. **Package manager installed** - Each platform requires its respective package manager (Homebrew, Snap, Chocolatey, etc.)
76
-
77
- ## Platform-Specific Installation
78
-
79
- ### macOS (Homebrew)
80
-
81
- #### Prerequisites
82
-
83
- - macOS 10.15 (Catalina) or later (macOS 14 Sonoma or later recommended)
84
- - Homebrew package manager installed
85
- - Terminal access
86
-
87
- If Homebrew is not installed, install it first:
88
-
89
- ```bash
90
- /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
91
- ```
92
-
93
- #### Installation Steps
94
-
95
- Run the following command to install yq via Homebrew:
96
-
97
- ```bash
98
- brew install --quiet yq
99
- ```
100
-
101
- The `--quiet` flag suppresses non-essential output, making the command suitable for automation scripts and CI/CD pipelines.
102
-
103
- **Note**: This installs Mike Farah's yq. Homebrew has a separate `python-yq` formula - do not install that one if you want the Go-based yq.
104
-
105
- #### Verification
106
-
107
- Confirm the installation succeeded:
108
-
109
- ```bash
110
- yq --version
111
- ```
112
-
113
- Expected output (version numbers may vary):
114
-
115
- ```
116
- yq (https://github.com/mikefarah/yq/) version v4.50.1
117
- ```
118
-
119
- Verify the installation path:
120
-
121
- ```bash
122
- which yq
123
- ```
124
-
125
- Expected output: `/opt/homebrew/bin/yq` (Apple Silicon) or `/usr/local/bin/yq` (Intel).
126
-
127
- #### Troubleshooting
128
-
129
- **Problem**: `yq: command not found` after installation
130
-
131
- **Solution**: Homebrew may not be in your PATH. For Apple Silicon Macs, add Homebrew to your PATH:
132
-
133
- ```bash
134
- eval "$(/opt/homebrew/bin/brew shellenv)"
135
- ```
136
-
137
- For a permanent fix, add this to your shell configuration:
138
-
139
- ```bash
140
- echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> ~/.zshrc && source ~/.zshrc
141
- ```
142
-
143
- **Problem**: `brew install yq` fails with permission errors
144
-
145
- **Solution**: Fix Homebrew directory ownership:
146
-
147
- ```bash
148
- sudo chown -R $(whoami) $(brew --prefix)/*
149
- ```
150
-
151
- **Problem**: Installed wrong yq (python-yq)
152
-
153
- **Solution**: If you accidentally installed python-yq, uninstall it and install the correct one:
154
-
155
- ```bash
156
- brew uninstall python-yq && brew install --quiet yq
157
- ```
158
-
159
- **Problem**: Installation fails with network errors
160
-
161
- **Solution**: Check your internet connection and try again. If behind a corporate proxy, configure Homebrew to use it:
162
-
163
- ```bash
164
- export ALL_PROXY=http://proxy.example.com:8080
165
- brew install --quiet yq
166
- ```
167
-
168
- ---
169
-
170
- ### Ubuntu/Debian (Snap)
171
-
172
- #### Prerequisites
173
-
174
- - Ubuntu 16.04 LTS or later, or Debian 10 (Buster) or later
175
- - sudo privileges
176
- - Internet connectivity
177
- - snapd installed (pre-installed on Ubuntu 16.04+)
178
-
179
- **Important**: The `yq` package in Ubuntu/Debian APT repositories is NOT Mike Farah's yq - it is a Python-based wrapper around jq called python-yq (kislyuk/yq). Do NOT install via `apt-get install yq` if you want Mike Farah's yq. Use Snap instead.
180
-
181
- #### Installation Steps
182
-
183
- Run the following command to install yq via Snap:
184
-
185
- ```bash
186
- sudo snap install yq
187
- ```
188
-
189
- Snap packages install non-interactively by default. The command downloads and installs the latest stable version from the Snap Store.
190
-
191
- #### Verification
192
-
193
- Confirm the installation succeeded:
194
-
195
- ```bash
196
- yq --version
197
- ```
198
-
199
- Expected output (version numbers may vary):
200
-
201
- ```
202
- yq (https://github.com/mikefarah/yq/) version v4.49.2
203
- ```
204
-
205
- **Note**: Snap may install a slightly older stable version compared to the absolute latest GitHub release. This is normal and the Snap version is well-tested.
206
-
207
- Verify the installation path:
208
-
209
- ```bash
210
- which yq
211
- ```
212
-
213
- Expected output: `/snap/bin/yq`
214
-
215
- #### Troubleshooting
216
-
217
- **Problem**: `snap: command not found`
218
-
219
- **Solution**: Install snapd first:
220
-
221
- ```bash
222
- sudo DEBIAN_FRONTEND=noninteractive apt-get update -y && sudo DEBIAN_FRONTEND=noninteractive apt-get install -y snapd
223
- ```
224
-
225
- Then reboot or log out and back in, and retry the yq installation.
226
-
227
- **Problem**: `yq: command not found` after snap installation
228
-
229
- **Solution**: Snap binaries may not be in your PATH. Add Snap's bin directory:
230
-
231
- ```bash
232
- echo 'export PATH="/snap/bin:$PATH"' >> ~/.bashrc && source ~/.bashrc
233
- ```
234
-
235
- **Problem**: Snap installation fails with permission errors
236
-
237
- **Solution**: Ensure you are using `sudo` with the snap install command.
238
-
239
- **Problem**: Need the absolute latest version
240
-
241
- **Solution**: Install from the edge channel or use direct binary download:
242
-
243
- ```bash
244
- sudo snap install yq --edge
245
- ```
246
-
247
- Or download the binary directly from GitHub:
248
-
249
- ```bash
250
- sudo curl -L -o /usr/local/bin/yq https://github.com/mikefarah/yq/releases/latest/download/yq_linux_amd64 && sudo chmod +x /usr/local/bin/yq
251
- ```
252
-
253
- ---
254
-
255
- ### Raspberry Pi OS (Snap)
256
-
257
- #### Prerequisites
258
-
259
- - Raspberry Pi OS (32-bit or 64-bit)
260
- - Raspberry Pi 2 or later (Raspberry Pi 3B+ or later recommended for 64-bit)
261
- - sudo privileges
262
- - Internet connectivity
263
- - snapd installed
264
-
265
- Raspberry Pi OS is based on Debian. Like Ubuntu/Debian, the APT repositories contain python-yq, not Mike Farah's yq. Use Snap or direct binary download instead.
266
-
267
- #### Installation Steps
268
-
269
- **Step 1: Install snapd (if not already installed)**
270
-
271
- ```bash
272
- sudo DEBIAN_FRONTEND=noninteractive apt-get update -y && sudo DEBIAN_FRONTEND=noninteractive apt-get install -y snapd
273
- ```
274
-
275
- After installing snapd, reboot the Raspberry Pi:
276
-
277
- ```bash
278
- sudo reboot
279
- ```
280
-
281
- **Step 2: Install yq via Snap**
282
-
283
- After reboot, open a new terminal and run:
284
-
285
- ```bash
286
- sudo snap install yq
287
- ```
288
-
289
- **Alternative: Direct Binary Download (recommended for 32-bit)**
290
-
291
- For 32-bit Raspberry Pi OS or if Snap is not desired, download the ARM binary directly:
292
-
293
- For 64-bit (aarch64):
294
-
295
- ```bash
296
- sudo curl -L -o /usr/local/bin/yq https://github.com/mikefarah/yq/releases/latest/download/yq_linux_arm64 && sudo chmod +x /usr/local/bin/yq
297
- ```
298
-
299
- For 32-bit (armv7l/armhf):
300
-
301
- ```bash
302
- sudo curl -L -o /usr/local/bin/yq https://github.com/mikefarah/yq/releases/latest/download/yq_linux_arm && sudo chmod +x /usr/local/bin/yq
303
- ```
304
-
305
- #### Verification
306
-
307
- Confirm the installation succeeded:
308
-
309
- ```bash
310
- yq --version
311
- ```
312
-
313
- Expected output (version numbers may vary):
314
-
315
- ```
316
- yq (https://github.com/mikefarah/yq/) version v4.49.2
317
- ```
318
-
319
- Verify your architecture:
320
-
321
- ```bash
322
- uname -m
323
- ```
324
-
325
- Expected output: `aarch64` (64-bit) or `armv7l` (32-bit).
326
-
327
- Verify the installation path:
328
-
329
- ```bash
330
- which yq
331
- ```
332
-
333
- Expected output: `/snap/bin/yq` (Snap) or `/usr/local/bin/yq` (binary download).
334
-
335
- #### Troubleshooting
336
-
337
- **Problem**: Snap installation hangs or is very slow
338
-
339
- **Solution**: Raspberry Pi may have limited bandwidth or processing power. Use the direct binary download method instead, which is faster.
340
-
341
- **Problem**: `snap: command not found`
342
-
343
- **Solution**: Ensure snapd is installed and you have rebooted after installation:
344
-
345
- ```bash
346
- sudo DEBIAN_FRONTEND=noninteractive apt-get install -y snapd
347
- sudo reboot
348
- ```
349
-
350
- **Problem**: Wrong architecture binary downloaded
351
-
352
- **Solution**: Check your architecture with `uname -m` and download the correct binary:
353
- - `aarch64` = use `yq_linux_arm64`
354
- - `armv7l` = use `yq_linux_arm`
355
-
356
- **Problem**: Permission denied when running yq
357
-
358
- **Solution**: Ensure the binary has execute permissions:
359
-
360
- ```bash
361
- sudo chmod +x /usr/local/bin/yq
362
- ```
363
-
364
- ---
365
-
366
- ### Amazon Linux (Direct Binary Download)
367
-
368
- #### Prerequisites
369
-
370
- - Amazon Linux 2023 (AL2023) or Amazon Linux 2 (AL2)
371
- - sudo privileges
372
- - Internet connectivity
373
- - curl or wget installed (pre-installed on Amazon Linux)
374
-
375
- **Important**: Mike Farah's yq is NOT available in the standard Amazon Linux repositories. Use direct binary download for installation.
376
-
377
- #### Installation Steps
378
-
379
- Run the following commands to download and install yq:
380
-
381
- For x86_64 instances:
382
-
383
- ```bash
384
- sudo curl -L -o /usr/local/bin/yq https://github.com/mikefarah/yq/releases/latest/download/yq_linux_amd64 && sudo chmod +x /usr/local/bin/yq
385
- ```
386
-
387
- For ARM-based instances (Graviton):
388
-
389
- ```bash
390
- sudo curl -L -o /usr/local/bin/yq https://github.com/mikefarah/yq/releases/latest/download/yq_linux_arm64 && sudo chmod +x /usr/local/bin/yq
391
- ```
392
-
393
- This downloads the latest stable release directly from GitHub and installs it to `/usr/local/bin/`.
394
-
395
- #### Verification
396
-
397
- Confirm the installation succeeded:
398
-
399
- ```bash
400
- yq --version
401
- ```
402
-
403
- Expected output (version numbers may vary):
404
-
405
- ```
406
- yq (https://github.com/mikefarah/yq/) version v4.50.1
407
- ```
408
-
409
- Check which architecture is installed:
410
-
411
- ```bash
412
- file /usr/local/bin/yq
413
- ```
414
-
415
- Expected output for x86_64: `ELF 64-bit LSB executable, x86-64`
416
- Expected output for ARM64: `ELF 64-bit LSB executable, ARM aarch64`
417
-
418
- Verify the installation path:
419
-
420
- ```bash
421
- which yq
422
- ```
423
-
424
- Expected output: `/usr/local/bin/yq`
425
-
426
- #### Troubleshooting
427
-
428
- **Problem**: `curl: command not found`
429
-
430
- **Solution**: curl should be pre-installed, but if missing:
431
-
432
- ```bash
433
- sudo dnf install -y curl
434
- ```
435
-
436
- Or for Amazon Linux 2:
437
-
438
- ```bash
439
- sudo yum install -y curl
440
- ```
441
-
442
- **Problem**: Permission denied when downloading
443
-
444
- **Solution**: Ensure you are using `sudo` for the curl and chmod commands.
445
-
446
- **Problem**: yq not found after installation
447
-
448
- **Solution**: `/usr/local/bin` should be in PATH by default. If not, add it:
449
-
450
- ```bash
451
- echo 'export PATH="/usr/local/bin:$PATH"' >> ~/.bashrc && source ~/.bashrc
452
- ```
453
-
454
- **Problem**: Need to install a specific version
455
-
456
- **Solution**: Replace `latest` with the specific version tag:
457
-
458
- ```bash
459
- sudo curl -L -o /usr/local/bin/yq https://github.com/mikefarah/yq/releases/download/v4.50.1/yq_linux_amd64 && sudo chmod +x /usr/local/bin/yq
460
- ```
461
-
462
- **Problem**: Downloaded wrong architecture
463
-
464
- **Solution**: Check your instance architecture first:
465
-
466
- ```bash
467
- uname -m
468
- ```
469
-
470
- Use `yq_linux_amd64` for `x86_64` and `yq_linux_arm64` for `aarch64`.
471
-
472
- ---
473
-
474
- ### Windows (Chocolatey)
475
-
476
- #### Prerequisites
477
-
478
- - Windows 10 (version 1803+) or Windows 11
479
- - Chocolatey package manager installed
480
- - Administrator PowerShell or Command Prompt
481
-
482
- If Chocolatey is not installed, install it first by running this command in an Administrator PowerShell:
483
-
484
- ```powershell
485
- 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'))
486
- ```
487
-
488
- #### Installation Steps
489
-
490
- Run the following command in an Administrator PowerShell or Command Prompt:
491
-
492
- ```powershell
493
- choco install yq -y
494
- ```
495
-
496
- The `-y` flag automatically confirms all prompts, enabling fully non-interactive installation.
497
-
498
- Chocolatey downloads the appropriate Windows binary and adds it to the PATH automatically.
499
-
500
- #### Verification
501
-
502
- Open a **new** Command Prompt or PowerShell window (required for PATH to update), then run:
503
-
504
- ```powershell
505
- yq --version
506
- ```
507
-
508
- Expected output (version numbers may vary):
509
-
510
- ```
511
- yq (https://github.com/mikefarah/yq/) version v4.50.1
512
- ```
513
-
514
- Verify the installation path:
515
-
516
- ```powershell
517
- where yq
518
- ```
519
-
520
- Expected output: `C:\ProgramData\chocolatey\bin\yq.exe`
521
-
522
- #### Troubleshooting
523
-
524
- **Problem**: `yq` command not found after installation
525
-
526
- **Solution**: Close all terminal windows and open a new Command Prompt or PowerShell. The PATH update requires a fresh terminal session.
527
-
528
- **Problem**: `choco` command not found
529
-
530
- **Solution**: Chocolatey may not be in PATH. Close all terminal windows, open a new Administrator PowerShell, and try again. If the issue persists, reinstall Chocolatey.
531
-
532
- **Problem**: Installation fails with access denied
533
-
534
- **Solution**: Ensure you are running PowerShell or Command Prompt as Administrator. Right-click and select "Run as administrator".
535
-
536
- **Problem**: Need to use winget instead of Chocolatey
537
-
538
- **Solution**: winget is also supported. Run the following in PowerShell or Command Prompt:
539
-
540
- ```powershell
541
- winget install --id MikeFarah.yq --silent --accept-package-agreements --accept-source-agreements
542
- ```
543
-
544
- The `--silent` flag ensures non-interactive installation.
545
-
546
- **Note**: The winget version may be slightly older than the Chocolatey version. Check the version after installation.
547
-
548
- ---
549
-
550
- ### WSL (Ubuntu)
551
-
552
- #### Prerequisites
553
-
554
- - Windows 10 version 2004+ or Windows 11
555
- - Windows Subsystem for Linux (WSL) with Ubuntu installed
556
- - WSL 2 recommended for best performance
557
- - sudo privileges within WSL
558
-
559
- WSL Ubuntu follows the same process as native Ubuntu - use Snap or direct binary download.
560
-
561
- #### Installation Steps
562
-
563
- Open your WSL Ubuntu terminal and run:
564
-
565
- **Option 1: Via Snap (if snapd is available)**
566
-
567
- ```bash
568
- sudo snap install yq
569
- ```
570
-
571
- **Option 2: Direct Binary Download (recommended for WSL)**
572
-
573
- ```bash
574
- sudo curl -L -o /usr/local/bin/yq https://github.com/mikefarah/yq/releases/latest/download/yq_linux_amd64 && sudo chmod +x /usr/local/bin/yq
575
- ```
576
-
577
- The direct binary download is often more reliable in WSL environments.
578
-
579
- #### Verification
580
-
581
- Confirm the installation succeeded:
582
-
583
- ```bash
584
- yq --version
585
- ```
586
-
587
- Expected output (version numbers may vary):
588
-
589
- ```
590
- yq (https://github.com/mikefarah/yq/) version v4.50.1
591
- ```
592
-
593
- Verify the installation path:
594
-
595
- ```bash
596
- which yq
597
- ```
598
-
599
- Expected output: `/snap/bin/yq` (Snap) or `/usr/local/bin/yq` (binary download).
600
-
601
- #### Troubleshooting
602
-
603
- **Problem**: Snap commands fail in WSL
604
-
605
- **Solution**: Snap support in WSL can be problematic. Use the direct binary download method instead:
606
-
607
- ```bash
608
- sudo curl -L -o /usr/local/bin/yq https://github.com/mikefarah/yq/releases/latest/download/yq_linux_amd64 && sudo chmod +x /usr/local/bin/yq
609
- ```
610
-
611
- **Problem**: WSL itself is not installed
612
-
613
- **Solution**: Install WSL from an Administrator PowerShell on Windows:
614
-
615
- ```powershell
616
- wsl --install
617
- ```
618
-
619
- Restart your computer after installation.
620
-
621
- **Problem**: Network connectivity issues in WSL
622
-
623
- **Solution**: WSL may have DNS resolution issues. Try restarting WSL:
624
-
625
- ```powershell
626
- # From Windows PowerShell
627
- wsl --shutdown
628
- wsl
629
- ```
630
-
631
- **Problem**: `/usr/local/bin` not in PATH
632
-
633
- **Solution**: Add it to your PATH:
634
-
635
- ```bash
636
- echo 'export PATH="/usr/local/bin:$PATH"' >> ~/.bashrc && source ~/.bashrc
637
- ```
638
-
639
- ---
640
-
641
- ### Git Bash (Manual/Portable)
642
-
643
- #### Prerequisites
644
-
645
- - Windows 10 or Windows 11
646
- - Git for Windows installed (includes Git Bash)
647
- - Internet connectivity
648
-
649
- Git Bash does not include yq by default. Download the Windows binary and place it in a directory included in Git Bash's PATH.
650
-
651
- #### Installation Steps
652
-
653
- Open Git Bash and run the following commands:
654
-
655
- **Step 1: Create the local bin directory (if it does not exist)**
656
-
657
- ```bash
658
- mkdir -p /usr/local/bin
659
- ```
660
-
661
- **Step 2: Download the yq Windows binary**
662
-
663
- ```bash
664
- curl -L -o /usr/local/bin/yq.exe https://github.com/mikefarah/yq/releases/latest/download/yq_windows_amd64.exe
665
- ```
666
-
667
- This downloads the latest yq release directly from the official GitHub releases.
668
-
669
- #### Verification
670
-
671
- Confirm the installation succeeded:
672
-
673
- ```bash
674
- yq --version
675
- ```
676
-
677
- Expected output (version numbers may vary):
678
-
679
- ```
680
- yq (https://github.com/mikefarah/yq/) version v4.50.1
681
- ```
682
-
683
- Verify yq is accessible:
684
-
685
- ```bash
686
- which yq
687
- ```
688
-
689
- Expected output: `/usr/local/bin/yq`
690
-
691
- #### Troubleshooting
692
-
693
- **Problem**: `yq: command not found`
694
-
695
- **Solution**: The `/usr/local/bin` directory may not be in Git Bash's PATH. Add it manually:
696
-
697
- ```bash
698
- echo 'export PATH="/usr/local/bin:$PATH"' >> ~/.bashrc && source ~/.bashrc
699
- ```
700
-
701
- **Problem**: Permission denied when downloading
702
-
703
- **Solution**: Run Git Bash as Administrator. Press Windows key, type "Git Bash", then press Ctrl+Shift+Enter.
704
-
705
- **Problem**: SSL certificate errors during download
706
-
707
- **Solution**: Update the CA certificates or use the `-k` flag (not recommended for production):
708
-
709
- ```bash
710
- curl -k -L -o /usr/local/bin/yq.exe https://github.com/mikefarah/yq/releases/latest/download/yq_windows_amd64.exe
711
- ```
712
-
713
- **Problem**: Need 32-bit version
714
-
715
- **Solution**: Download the 32-bit binary instead:
716
-
717
- ```bash
718
- curl -L -o /usr/local/bin/yq.exe https://github.com/mikefarah/yq/releases/latest/download/yq_windows_386.exe
719
- ```
720
-
721
- **Problem**: Want to install to Git's built-in bin directory
722
-
723
- **Solution**: Alternatively, copy to Git's usr/bin directory (requires running Git Bash as Administrator):
724
-
725
- ```bash
726
- curl -L -o /usr/bin/yq.exe https://github.com/mikefarah/yq/releases/latest/download/yq_windows_amd64.exe
727
- ```
728
-
729
- ---
730
-
731
- ## Post-Installation Configuration
732
-
733
- yq works out of the box for most use cases. No additional configuration is typically required. The following optional tips may be useful:
734
-
735
- ### Shell Aliases
736
-
737
- Create convenient aliases for common yq operations. Add to your shell configuration file (`~/.bashrc`, `~/.zshrc`, or `~/.bash_profile`):
738
-
739
- ```bash
740
- # Pretty-print YAML
741
- alias ypp='yq eval .'
742
-
743
- # Convert YAML to JSON
744
- alias y2j='yq eval -o=json'
745
-
746
- # Convert JSON to YAML
747
- alias j2y='yq eval -P'
748
-
749
- # Evaluate in-place
750
- alias yqi='yq eval -i'
751
- ```
752
-
753
- ### Tab Completion
754
-
755
- yq supports shell completion for Bash, Zsh, Fish, and PowerShell.
756
-
757
- **Bash:**
758
-
759
- ```bash
760
- echo 'source <(yq shell-completion bash)' >> ~/.bashrc && source ~/.bashrc
761
- ```
762
-
763
- **Zsh:**
764
-
765
- ```bash
766
- echo 'source <(yq shell-completion zsh)' >> ~/.zshrc && source ~/.zshrc
767
- ```
768
-
769
- **PowerShell:**
770
-
771
- ```powershell
772
- yq shell-completion powershell | Out-String | Invoke-Expression
773
- ```
774
-
775
- To make it permanent in PowerShell, add to your profile:
776
-
777
- ```powershell
778
- Add-Content $PROFILE 'yq shell-completion powershell | Out-String | Invoke-Expression'
779
- ```
780
-
781
- ### Test Your Installation
782
-
783
- Verify yq can parse YAML correctly:
784
-
785
- ```bash
786
- echo 'name: yq
787
- version: 4.50.1' | yq '.name'
788
- ```
789
-
790
- Expected output:
791
-
792
- ```
793
- yq
794
- ```
795
-
796
- Test JSON output:
797
-
798
- ```bash
799
- echo 'name: yq
800
- version: 4.50.1' | yq -o=json
801
- ```
802
-
803
- Expected output:
804
-
805
- ```json
806
- {
807
- "name": "yq",
808
- "version": "4.50.1"
809
- }
810
- ```
811
-
812
- ---
813
-
814
- ## Common Issues
815
-
816
- ### Issue: "Error: bad file descriptor" on Windows
817
-
818
- **Symptoms**: yq fails with file descriptor errors when reading from stdin on Windows.
819
-
820
- **Solution**: This can occur with certain terminal configurations. Use file input instead of stdin:
821
-
822
- ```powershell
823
- yq eval '.key' input.yaml
824
- ```
825
-
826
- Or redirect input explicitly:
827
-
828
- ```powershell
829
- Get-Content input.yaml | yq eval '.key'
830
- ```
831
-
832
- ### Issue: Wrong yq installed (python-yq vs Go yq)
833
-
834
- **Symptoms**: yq version shows Python or uses different syntax.
835
-
836
- **Solution**: You may have installed the Python-based yq (kislyuk/yq) instead of Mike Farah's Go-based yq. Check which one is installed:
837
-
838
- ```bash
839
- yq --version
840
- ```
841
-
842
- Mike Farah's yq shows: `yq (https://github.com/mikefarah/yq/) version vX.X.X`
843
- Python yq shows: `yq X.X.X`
844
-
845
- To fix, uninstall the Python version and install Mike Farah's yq using Snap or direct binary download.
846
-
847
- ### Issue: "null" output when key does not exist
848
-
849
- **Symptoms**: yq returns `null` when querying a non-existent key.
850
-
851
- **Solution**: This is expected behavior. To handle missing keys gracefully, use the alternative operator:
852
-
853
- ```bash
854
- echo 'name: yq' | yq '.missing // "default"'
855
- ```
856
-
857
- ### Issue: YAML anchors and aliases not resolved
858
-
859
- **Symptoms**: yq output contains `*anchor` references instead of resolved values.
860
-
861
- **Solution**: Use the `explode` function to resolve anchors:
862
-
863
- ```bash
864
- yq 'explode(.)' file.yaml
865
- ```
866
-
867
- ### Issue: Comments are lost when editing
868
-
869
- **Symptoms**: yq removes comments when modifying YAML files.
870
-
871
- **Solution**: yq preserves comments in most cases, but complex operations may lose them. For simple value updates, comments are preserved:
872
-
873
- ```bash
874
- yq -i '.version = "2.0.0"' file.yaml
875
- ```
876
-
877
- For complex operations, consider using `--prettyPrint` flag.
878
-
879
- ### Issue: Large YAML files cause memory issues
880
-
881
- **Symptoms**: Processing very large YAML files causes yq to consume excessive memory.
882
-
883
- **Solution**: yq streams by default for many operations, but very large files may still cause issues. Consider splitting large files or using streaming mode where applicable.
884
-
885
- ### Issue: PowerShell quoting problems
886
-
887
- **Symptoms**: yq expressions fail in PowerShell with parsing errors.
888
-
889
- **Solution**: PowerShell has different quoting rules. Use single quotes for yq expressions:
890
-
891
- ```powershell
892
- yq '.key' file.yaml
893
- ```
894
-
895
- For complex expressions, escape internal quotes:
896
-
897
- ```powershell
898
- yq '.items[] | select(.name == \"value\")' file.yaml
899
- ```
900
-
901
- Or use PowerShell's here-string:
902
-
903
- ```powershell
904
- yq @'
905
- .items[] | select(.name == "value")
906
- '@ file.yaml
907
- ```
908
-
909
- ### Issue: Updating yq to latest version
910
-
911
- **Symptoms**: Need to upgrade to the latest yq version.
912
-
913
- **Solution**:
914
-
915
- For Homebrew:
916
- ```bash
917
- brew upgrade yq
918
- ```
919
-
920
- For Snap:
921
- ```bash
922
- sudo snap refresh yq
923
- ```
924
-
925
- For Chocolatey:
926
- ```bash
927
- choco upgrade yq -y
928
- ```
929
-
930
- For manual installation, re-run the curl download command with the latest URL.
931
-
932
- ---
933
-
934
- ## References
935
-
936
- - [yq Official Documentation](https://mikefarah.gitbook.io/yq/)
937
- - [yq GitHub Repository](https://github.com/mikefarah/yq)
938
- - [yq GitHub Releases](https://github.com/mikefarah/yq/releases)
939
- - [yq Homebrew Formula](https://formulae.brew.sh/formula/yq)
940
- - [yq Snap Package](https://snapcraft.io/yq)
941
- - [yq Chocolatey Package](https://community.chocolatey.org/packages/yq)
942
- - [yq winget Package](https://winget.run/pkg/MikeFarah/yq)
943
- - [yq Operators Reference](https://mikefarah.gitbook.io/yq/operators)
944
- - [yq Recipes and Examples](https://mikefarah.gitbook.io/yq/recipes)