Data

Tools

Indexes

Applications

Experiments

Ruby

A summary of data about the Ruby ecosystem.

https://github.com/guard/guard

Guard is a command line tool to easily handle events on file system modifications.
https://github.com/guard/guard

Keywords from Contributors

activerecord activejob mvc rubygems rack rspec sinatra rubocop sidekiq crash-reporting

Last synced: about 11 hours ago
JSON representation

Repository metadata

Guard is a command line tool to easily handle events on file system modifications.

README.md

Guard

Gem Version Build Status Code Climate Test Coverage Inline docs Reviewed by Hound

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:

Before you file an issue, make sure you have read the known issues and file an issue sections that contains some important information.

Features

  • File system changes handled by our awesome Listen gem.
  • Support for visual system notifications.
  • Huge eco-system with more than 300 Guard plugins.
  • Tested against the latest Ruby 2.4.x, 2.5.x, 2.6.x, JRuby & Rubinius. See .travis-ci.yml for the exact versions.

Screencast

Two nice screencasts are available to help you get started:

Installation

The simplest way to install Guard is to use Bundler.

Add Guard (and any other dependencies) to a Gemfile in your project’s root:

group :development do
  gem 'guard'
end

then install it by running Bundler:

$ bundle

Generate an empty Guardfile with:

$ 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.

Avoiding gem/dependency problems

It's important that you always run Guard through Bundler to avoid errors.

If you're getting sick of typing bundle exec all the time, try one of the following:

  • (Recommended) Running bundle binstub guard will create bin/guard in 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 .bashrc or similar and the execute only be guard.
    Protip: It will work for all comands executed in bundle exec context!

  • Or, for RubyGems >= 2.2.0 (at least, though the more recent the better),
    simply set the RUBYGEMS_GEMDEPS environment 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 rvm rubygems command).

NOTE: this Rubygems feature is still under development still lacks many features of bundler

Add Guard plugins

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 guard-
on RubyGems.

When you have found a Guard plugin of your interest, add it to your Gemfile:

group :development do
  gem '<guard-plugin-name>'
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.

Usage

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

Start

Just launch Guard inside your Ruby or Rails project with:

$ bundle exec guard

Guard will look for a Guardfile or guardfile.rb in your current directory. If it does not find one, it will look
in your $HOME directory for a .Guardfile.

Please look here to see all the command line options for Guard

Interactions

Please read how to interact with Guard on the console and which signals Guard accepts

Guardfile DSL

For details on extending your Guardfile look at Guardfile examples or look at a list of commands Guardfile-DSL / Configuring-Guard

Issues

Before reporting a problem, please read how to File an issue.

Development / Contributing

See the Contributing Guide.

Releasing

Prerequisites

  • You must have commit rights to the GitHub repository.
  • You must have push rights for rubygems.org.

How to release

  1. Determine which would be the correct next version number according to semver.
  2. Update the version in ./lib/guard/version.rb.
  3. Commit the version in a single commit, the message should be "Bump VERSION to X.Y.Z".
  4. Push and open a pull request.
  5. Once CI is green, merge the pull request.
  6. Pull the changes locally and run bundle exec rake release:full; this will tag, push to GitHub, publish to rubygems.org, and publish the release notes .

Author

Thibaud Guillaume-Gentil (@thibaudgg)

Core Team

Contributors

https://github.com/guard/guard/graphs/contributors

Owner metadata

GitHub Events

Total
Last Year

Committers metadata

Last synced: 4 days ago

Total Commits: 2,046
Total Committers: 188
Avg Commits per committer: 10.883
Development Distribution Score (DDS): 0.732

Commits in past year: 3
Committers in past year: 3
Avg Commits per committer in past year: 1.0
Development Distribution Score (DDS) in past year: 0.667

Name Email Commits
Michael Kessler m****i@n****h 549
Cezary Baginski c****y@c****t 323
Thibaud Guillaume-Gentil t****d@t****e 290
Rémy Coutable r****y@r****e 228
Rémy Coutable r****i@r****e 136
Yann Lugrin y****n@s****t 30
Eduard Thamm e****m@t****t 30
Maher Sallam m****r@s****e 23
Rémy Coutable r****i@r****m 18
John Bintz j****n@c****m 16
Adam Spiers g****d@a****g 15
slavic s****r@g****m 14
Wouter de Vos w****r@s****m 10
Olle Jonsson o****n@g****m 10
Kevin Krauss e****s@g****m 10
Darren Pearce l****d@g****m 10
monocle h****9@g****m 9
Josh Hull j****y@g****m 8
Alan Dipert a****n@d****g 8
cablegram c****m@g****m 7
Amiel Martin a****n@g****m 7
Christian Höltje d****t@g****g 7
Matthijs Groen m****n@g****m 7
Niklas Hofer n****v@l****e 6
Tim Finley t****y@h****m 6
mrloop e****n@m****m 6
Mislav Marohnić m****c@g****m 6
Joshua Hawxwell m@h****e 5
Nick Mabry n****y@g****m 5
Scott Parrish a****i@g****m 5
and 158 more...

Committer domains:

Issue and Pull Request metadata

Last synced: 9 days ago

Total issues: 63
Total pull requests: 55
Average time to close issues: 12 months
Average time to close pull requests: 3 months
Total issue authors: 42
Total pull request authors: 20
Average comments per issue: 3.37
Average comments per pull request: 1.29
Merged pull request: 39
Bot issues: 0
Bot pull requests: 0

Past year issues: 5
Past year pull requests: 8
Past year average time to close issues: 15 minutes
Past year average time to close pull requests: 15 days
Past year issue authors: 4
Past year pull request authors: 5
Past year average comments per issue: 0.0
Past year average comments per pull request: 0.38
Past year merged pull request: 4
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/guard/guard

Top Issue Authors

  • e2 (19)
  • svoop (2)
  • ioquatix (2)
  • mtasaka (2)
  • kapooostin (1)
  • nickmjones (1)
  • devsheva (1)
  • pitosalas (1)
  • beporter (1)
  • dsandstrom (1)
  • rhulse (1)
  • hyunwoona (1)
  • dogweather (1)
  • karnowski (1)
  • martyphee (1)

Top Pull Request Authors

  • rymai (26)
  • olleolleolle (7)
  • e2 (2)
  • JasonnnW3000 (2)
  • kewlar (2)
  • mark-young-atg (2)
  • Mifrill (1)
  • pocke (1)
  • caseyprovost (1)
  • dougbradbury (1)
  • svoop (1)
  • salbertson (1)
  • jackorp (1)
  • quintrino (1)
  • mishina2228 (1)

Top Issue Labels

  • ✨ Feature (21)
  • bug (2)
  • duplicate (1)
  • help needed (1)
  • work in progress (1)

Top Pull Request Labels

  • 🏠 Housekeeping (12)
  • ⚠️ Breaking (4)
  • 🐛 Bug Fix (4)
  • bug (3)
  • ✨ Feature (2)

Package metadata

gem.coop: guard

Guard is a command line tool to easily handle events on file system modifications.

  • Homepage: https://guard.github.io/guard/
  • Documentation: http://www.rubydoc.info/gems/guard/
  • Licenses: MIT
  • Latest release: 2.19.1 (published 11 months ago)
  • Last Synced: 2025-12-08T22:31:39.586Z (1 day ago)
  • Versions: 137
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 140,947,952 Total
  • Docker Downloads: 734,732,017
  • Rankings:
    • Dependent repos count: 0.0%
    • Dependent packages count: 0.0%
    • Average: 0.074%
    • Docker downloads count: 0.124%
    • Downloads: 0.17%
  • Maintainers (2)
rubygems.org: guard

Guard is a command line tool to easily handle events on file system modifications.

  • Homepage: https://guard.github.io/guard/
  • Documentation: http://www.rubydoc.info/gems/guard/
  • Licenses: MIT
  • Latest release: 2.19.1 (published 11 months ago)
  • Last Synced: 2025-12-09T01:31:54.515Z (1 day ago)
  • Versions: 137
  • Dependent Packages: 3,438
  • Dependent Repositories: 84,420
  • Downloads: 140,953,784 Total
  • Docker Downloads: 734,732,017
  • Rankings:
    • Dependent packages count: 0.016%
    • Dependent repos count: 0.128%
    • Docker downloads count: 0.162%
    • Downloads: 0.176%
    • Stargazers count: 0.19%
    • Average: 0.313%
    • Forks count: 1.209%
  • Maintainers (2)
proxy.golang.org: github.com/guard/guard

  • Homepage:
  • Documentation: https://pkg.go.dev/github.com/guard/guard#section-documentation
  • Licenses: mit
  • Latest release: v2.19.1+incompatible (published 11 months ago)
  • Last Synced: 2025-12-07T21:03:46.251Z (2 days ago)
  • Versions: 125
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Rankings:
    • Stargazers count: 0.836%
    • Forks count: 1.291%
    • Average: 4.099%
    • Dependent repos count: 4.717%
    • Dependent packages count: 9.553%
rubygems.org: joshbuddy-guard

Guard is a command line tool to easily handle events on file system modifications.

  • Homepage: https://github.com/guard/guard
  • Documentation: http://www.rubydoc.info/gems/joshbuddy-guard/
  • Licenses: mit
  • Latest release: 0.10.0 (published almost 14 years ago)
  • Last Synced: 2025-12-07T21:03:43.688Z (2 days ago)
  • Versions: 1
  • Dependent Packages: 2
  • Dependent Repositories: 1
  • Downloads: 6,666 Total
  • Rankings:
    • Stargazers count: 0.188%
    • Forks count: 1.189%
    • Dependent packages count: 5.265%
    • Average: 17.291%
    • Dependent repos count: 21.728%
    • Downloads: 58.088%
  • Maintainers (1)
gem.coop: joshbuddy-guard

Guard is a command line tool to easily handle events on file system modifications.

  • Homepage: https://github.com/guard/guard
  • Documentation: http://www.rubydoc.info/gems/joshbuddy-guard/
  • Licenses: mit
  • Latest release: 0.10.0 (published almost 14 years ago)
  • Last Synced: 2025-12-07T21:03:43.690Z (2 days ago)
  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 6,666 Total
  • Rankings:
    • Dependent repos count: 0.0%
    • Dependent packages count: 0.0%
    • Average: 19.641%
    • Downloads: 58.923%
  • Maintainers (1)

Dependencies

Gemfile rubygems
  • aruba ~> 0.14 development
  • codecov >= 0 development
  • gems >= 0 development
  • guard-cucumber ~> 2.1 development
  • guard-ronn >= 0 development
  • guard-rspec >= 0 development
  • guard-rubocop >= 0 development
  • netrc >= 0 development
  • notiffany >= 0.0.6 development
  • octokit >= 0 development
  • redcarpet >= 0 development
  • rspec >= 3.0.0 development
  • rubocop = 0.83.0 development
  • yard >= 0 development
  • json >= 0
  • psych >= 0
  • racc >= 0
  • rake >= 0
  • rubinius-coverage >= 0
guard.gemspec rubygems
  • formatador >= 0.2.4
  • listen >= 2.7, < 4.0
  • lumberjack >= 1.0.12, < 2.0
  • nenv ~> 0.1
  • notiffany ~> 0.0
  • pry >= 0.13.0
  • shellany ~> 0.0
  • thor >= 0.18.1
.github/workflows/push.yml actions
  • actions/checkout master composite
  • toolmantim/release-drafter v5.2.0 composite

Score: 35.3303235390732