plowmod(1)

💖 plowmod(1) — the plowshare modules management tool, bestie edition 💖

okay so before we even get into it: this is plowmod, and it lives in the Plowshare for Bash 4 manual. it's a lil command-line bestie whose whole job is making plowshare modules install and update without you crying. 🫶

---

✨ NAME ✨

plowmod — a simple plowshare modules management tool. simple!! as in, it does the annoying stuff so you don't have to. 💅

---

✨ SYNOPSIS ✨

plowmod ACTION [OPTIONS]... [URL]...
plowmod --install [URL]...
plowmod --update
plowmod --status

like. pick an action, sprinkle some options, maybe yeet a URL in there. that's the whole vibe. 🌸

---

✨ DESCRIPTION ✨

so plowmod is a command-line tool built specifically to make installing and updating plowshare modules not a whole ordeal. and the best part? the script is standalone — it does not depend on any of the other plow* tools. she's independent. she's her own main character. 👑

here's the tea tho 🍓: when you actually fire up plowdown, plowup, plowprobe, plowlist or plowdel, they go looking for ~/.config/plowshare/modules.d/*/config files and build themselves an available-module list from whatever they find. so that's why plowmod exists — to keep that directory cute and current.

and about remote repository sources (aka the URLs you pass in): for now they can only be git repositories. no cap. git or nothing. 🙈

---

✨ OPTIONS ✨

🎀 Action options

• -i, --install — install from scratch, from one or several URLs, straight into the plowshare modules directory (peep the --modules-directory switch below for where exactly 👀). for now it's literally just a git clone. from the repository URL, a sub-directory name gets figured out (it's some kind of basename situation) and that's what gets created inside the plowshare modules directory.
• -s, --status — prints some genuinely useful info about the modules directories it found, plus any possible conflicts. the conflict tea only spills when you're using the -v3 switch. 🫖
• -u, --update — browses the plowshare modules directory (every single sub-directory, one by one) and tries to update the sources. for now this is just a plain ol' git pull.

🌈 Logging options

• -v, --verbose=LEVEL — sets how chatty the output is:
  • 0 — none
  • 1 — errors
  • 2 — notice (this is the default behavior, bestie)
  • 3 — debug
  • 4 — report (very noisy, not very useful here 💀)
• -q, --quiet — an alias for -v0. do not print any debug messages. silence. peace. 🧘

🦋 Miscellaneous options

• --no-color — disables output coloring for log messages (stderr only).
• --modules-directory=DIR — sets the plowshare modules directory. the default is ~/.config/plowshare/modules.d/. you should not modify this unless you're a package maintainer or you're trying to embed plowshare into PHP. fr fr, leave it alone otherwise. 🙅

⭐ Generic program information

• -h, --help — display the main help and exit. classic.
• --version — output version information and exit. also classic.

---

✨ FILES ✨

• ~/.config/plowshare/modules.d/ — the user plowshare modules directory, where repository sources get installed and updated. this location prevails over the ones listed below it. 👑
• /usr/share/plowshare/modules/ — (replace /usr with your installation prefix) since plowshare isn't delivered with modules anymore, this one is unused. it's still supported for compatibility purposes, but you are discouraged from using it. it's giving legacy. 💀
• ~/.config/plowshare/modules/ — the obsolete user modules directory. prefer using ~/.config/plowshare/modules.d/xxx/ instead. respectfully, move on. 🎀

---

✨ ENVIRONMENT VARIABLES ✨

the following environment variables may affect plowmod:

• HOME — search for the user configuration directory in ~/.config/plowshare (see the FILES section above).
• PLOWSHARE_CURL — specifies an alternate curl command (a $PATH search is considered). if it's not defined, curl is used.
• XDG_CONFIG_HOME — the directory to store user configuration files. if it's not defined, ~/.config is assumed.

---

✨ EXIT CODES ✨

possible exit codes are:

• 0 — operation success. slay. ✨
• 1 — fatal error. unexpected result. 😭
• 8 — system generic error.
• 15 — unknown command line parameter or incompatible options.

and here's the plot twist: if plowmod is invoked with multiple URLs (command-line arguments) and one or several errors occur, the first error code is returned added with 100. so like, math. but make it chaos. 🔥

---

✨ AUTHORS ✨

plowshare was initially written by Arnau Sanchez. see the AUTHORS file for a list of some of the many other contributors. 💜

plowshare is (C) 2010-2016 The Plowshare Team.

---

✨ SEE ALSO ✨

plowdown(1), plowup(1), plowdel(1), plowlist(1), plowprobe(1), plowshare.conf(5).

---

okay that's the whole page!! this beauty is licensed GPL and was dated July 13, 2016, so when you're out here cloning and pulling modules like a pro, just know you're standing on some iconic, slightly vintage shoulders. 🎀✨ go manage those modules bestie, you got this 💅🫶