GUARD(1)

💖 GUARD(1) — like, the manual, but make it cute 💖

okay bestie, welcome to guard(1) 🫶 this is the manual page for Guard, and yes, we're doing this in full group-chat mode, but every single flag is staying exactly where it belongs. no cap.

---

✨ NAME ✨

guard — Guard keeps an eye on your file modifications. like a little guardian angel for your codebase 👀🦋

---

🌸 DESCRIPTION 🌸

Guard is a command line tool to easily handle events on file system modifications. that's it, that's the vibe. something changes in your files, Guard notices, stuff happens. it's giving watchful. it's giving reliable. 💅

---

🎀 SYNOPSIS 🎀

guard <COMMAND> <OPTIONS>

---

👑 COMMANDS 👑

🌈 start

Starts Guard. This is the default command if none is provided — so if you're out here typing nothing, Guard just starts. main character behaviour fr fr ✨

The following options are available:

• -c, --clear — Clears the Shell after each change. fresh screen, fresh me 🧼
• -n, --notify FLAG — Disable notifications (Growl or Libnotify depending on your system). Notifications can be disabled globally by setting a GUARD_NOTIFY environment variable to false. FLAG can be true/false or t/f. so many ways to say no thanks 🙈
• -g, --group GROUP1 GROUP2... — Scopes the Guard actions to the groups specified by GROUP1, GROUP2, etc. Group names should be separated by spaces. Plugins that don´t belong to a group are considered global and are always run — they're the extroverts of the plugin world, they show up to everything 💀
• -P, --plugin PLUGIN1 PLUGIN2... — Scopes the Guard actions to the plugins specified by PLUGIN1, PLUGIN2, etc. Plugin names should be separated by spaces.
• -d, --debug — Runs Guard in debug mode. detective mode activated 🔍
• -w, --watchdir PATH — Tells Guard to watch PATH instead of ./.
• -G, --guardfile FILE — Tells Guard to use FILE as its Guardfile instead of ./Guardfile or ~/.Guardfile.
• -i, --no-interactions — Turn off completely any Guard terminal interactions. do not perceive me 😭
• -B, --no-bundler-warning — Turn off warning when Bundler is not present.
• -l, --latency — Overwrite Listen´s default latency.
• -p, --force-polling — Force usage of the Listen polling listener.
• -y, --wait-for-delay — Overwrite Listen´s default wait_for_delay, useful for kate-like editors through ssh access.

---

🦋 init [GUARDS]

If no Guardfile is present in the current directory, creates an empty Guardfile. baby's first Guardfile 🥹

If GUARDS are present, add their default Guardfile configuration to the current Guardfile. Note that GUARDS is a list of the Guard plugin names without the guard- prefix. For instance to initialize guard-rspec, run guard init rspec.

so like. drop the prefix. the prefix is not invited to this party 🎀

---

⭐ list

Lists Guard plugins that can be used with the init command.

---

💜 -T, show

List defined groups and Guard plugins for the current Guardfile.

---

🌟 -h, help [COMMAND]

List all of Guard´s available commands.

If COMMAND is given, displays a specific help for TASK.

---

🔥 EXAMPLES 🔥

Initialize Guard and a specific Guard plugin at the same time:

[bundle exec] guard init [rspec]

Run Guard:

[bundle exec] guard [start] --watchdir ~/dev --guardfile ~/env/Guardfile
--clear --group backend frontend --notify false --debug

or in a more concise way:

[bundle exec] guard [start] -w ~/dev -G ~/env/Guardfile -c -g backend
frontend -n f -d

look at those long flags and short flags living their best lives. both valid. both iconic. 👑

---

💖 AUTHORS / CONTRIBUTORS 💖

Thibaud Guillaume-Gentil is the main author. 👑

A list of contributors based on all commits can be found here: https://github.com/guard/guard/contributors

---

🌸 CHANGELOG 🌸

The changelog can be found at: https://github.com/guard/guard/blob/master/CHANGELOG.md

This manual has been written by Remy Coutable.

---

🌈 WWW 🌈

http://guardgem.org/

---

and that's the whole page, bestie!! this manual dropped way back in November 2014 and it's still out here doing the most for GUARD(1) — the version and date are literally at the bottom of the original, so consider this your cute little sign-off. go watch some files. slay. 💅✨🦋