Guard is a command line tool to easily handle events on file system modifications.
IMPORTANT: Please upgrade to Ruby >= 2.4 before installing Guard! To install for older versions, update Bundler at least 1.12:
gem update bundlerand Bundler should correctly resolve to earlier gems for your given Ruby version.
:exclamation: Guard is currently accepting more maintainers. Please read this if you're interested in joining the team.
Guard automates various tasks by running custom rules whenever file or directories are modified.
It's frequently used by software developers, web designers, writers and other specialists to avoid mundane, repetitive actions and commands such as "relaunching" tools after changing source files or configurations.
Common use cases include: an IDE replacement, web development tools, designing "smart" and "responsive" build systems/workflows, automating various project tasks and installing/monitoring various system services.
For a full categorized list of known Guard plugins, look here: https://github.com/guard/guard/wiki/Guard-Plugins
If you have any questions about Guard or want to share some information with the Guard community, please go to one of the following places:
.travis-ci.ymlfor the exact versions.
Two nice screencasts are available to help you get started:
The simplest way to install Guard is to use Bundler.
Add Guard (and any other dependencies) to a
Gemfilein your project’s root:
group :development do gem 'guard' end
then install it by running Bundler:
Generate an empty
$ bundle exec guard init
Run Guard through Bundler with:
$ bundle exec guard
If you are on Mac OS X and have problems with either Guard not reacting to file changes or Pry behaving strange, then you should add proper Readline support to Ruby on macOS.
It's important that you always run Guard through Bundler to avoid errors.
If you're getting sick of typing
bundle execall the time, try one of the following:
bundle binstub guardwill create
bin/guardin your project, which means running
bin/guard(tab completion will save you a key stroke or two) will have the exact same result as
bundle exec guard.
Or, you can
alias be="bundle exec"in your
.bashrcor similar and the execute only
be guard. Protip: It will work for all comands executed in
Or, for RubyGems >= 2.2.0 (at least, though the more recent the better), simply set the
RUBYGEMS_GEMDEPSenvironment variable to
-(for autodetecting the Gemfile in the current or parent directories) or set it to the path of your Gemfile.
(To upgrade RubyGems from RVM, use the
NOTE: this Rubygems feature is still under development still lacks many features of bundler
Guard is now ready to use and you should add some Guard plugins for your specific use. Start exploring the many Guard plugins available by browsing the Guard organization on GitHub or by searching for
When you have found a Guard plugin of your interest, add it to your
group :development do gem '' end
See the init section of the Guard usage below to see how to install the supplied plugin template that you can install and to suit your needs.
Guard is run from the command line. Please open your terminal and go to your project work directory.
Look here for a full list of Guard commands
Just launch Guard inside your Ruby or Rails project with:
$ bundle exec guard
Guard will look for a
guardfile.rbin your current directory. If it does not find one, it will look in your
$HOMEdirectory for a
Please look here to see all the command line options for Guard
For details on extending your
Guardfilelook at Guardfile examples or look at a list of commands Guardfile-DSL / Configuring-Guard
Before reporting a problem, please read how to File an issue.
See the Contributing Guide.
bundle exec rake release:full; this will tag, push to GitHub, publish to rubygems.org, and publish the release notes .