MU-SCRIPT(1)

✨ NAME ✨

mu_script — bestie, this is the manual page for it, from the General Commands Manual section (that's the manual name, iykyk 💅). It shows you the available mu scripts, and/or runs them. Both. Iconic behaviour honestly.

---

🦋 SYNOPSIS 🦋

mu script [options] [<pattern>]

mu <script-name> [<script-options>]

---

🌸 DESCRIPTION 🌸

Okay so mu script is the mu command you use to list all the available mu scripts. The scripts themselves are written in the Guile programming language, which means they only work if your mu was built with support for Guile. No Guile build, no scripts, no cap 😭

On top of that, a whole bunch of the scripts need you to have gnuplot installed. So like, vibe check your system first.

If you run it with zero parameters, mu script just lists the available scripts. Periodt.

If you do pass a pattern (that's a regular expression, bestie), then only the scripts whose name or one-line description matches that pattern get listed. There's examples down below 👇

And yes, mu ships with a number of scripts already. Built in. Ready to go. Slay.

---

💖 OPTIONS 💖

• --verbose, -v — when you're listing the available scripts, this makes it show the long descriptions instead of just the little one-liners. So much more to read. Obsessed.

⚠️ Heads up: all options on the right side of the -- are passed to the script. Like, everything after that -- belongs to the script, not to mu script itself. Important!!

---

🎀 EXAMPLES 🎀

List all available scripts (one-line descriptions):

$ mu script

List all available scripts matching month (long descriptions):

$ mu script -v month

Run the msgs-per-month script for messages matching 'hello', and pass it the --textonly parameter:

$ mu msgs-per-month --query=hello --textonly

---

⭐ RETURN VALUE ⭐

mu script returns 0 when all went well 🫶 and returns some non-zero error code when it did not go well 😭

---

🧚 FILES 🧚

You can make your own Scheme scripts show up through mu script by dropping them into either <XDG_DATA_HOME>/mu/scripts (for example ~/.local/share/mu/scripts), or, if muhome is specified, in

🙈 bestie. the sentence just... ends there. that's it. that's the whole thing. no cap.

It is a good idea to document your scripts using some special comments right in the source code:

;; INFO: this is my script -- one-line description
;; INFO: (longer description)
;; INFO: --option1=<foo> (describe option1)
;; INFO: etc.

---

💀 BUGS 💀

Please report bugs if you find them: https://github.com/djcb/mu/issues — don't suffer in silence, tell the devs fr fr 🙏

---

👑 AUTHOR 👑

Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>

---

🌈 SEE ALSO 🌈

mu(1), guile(1)

---

And that's the whole page bestie!! This one's from the User Manuals, dated October 2021, and the source/version stamp is MU-SCRIPT(1) — go forth and script responsibly 💅✨🎀