{"id":13448400,"url":"https://github.com/guard/guard","last_synced_at":"2025-05-12T22:24:19.818Z","repository":{"id":41553754,"uuid":"812610","full_name":"guard/guard","owner":"guard","description":"Guard is a command line tool to easily handle events on file system modifications.","archived":false,"fork":false,"pushed_at":"2025-01-02T14:35:15.000Z","size":4028,"stargazers_count":6278,"open_issues_count":67,"forks_count":487,"subscribers_count":119,"default_branch":"master","last_synced_at":"2025-05-05T09:41:31.362Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/guard.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2010-08-02T16:26:44.000Z","updated_at":"2025-05-04T11:47:43.000Z","dependencies_parsed_at":"2023-01-31T00:01:13.970Z","dependency_job_id":"55c4a46b-45d9-4bb1-a58c-94061320ed64","html_url":"https://github.com/guard/guard","commit_stats":{"total_commits":2045,"total_committers":187,"mean_commits":"10.935828877005347","dds":0.7315403422982885,"last_synced_commit":"143597c8a662346ccbb3147f49c0b25e8a20ea1b"},"previous_names":[],"tags_count":141,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guard%2Fguard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guard%2Fguard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guard%2Fguard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guard%2Fguard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/guard","download_url":"https://codeload.github.com/guard/guard/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252531164,"owners_count":21763289,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-31T05:01:44.469Z","updated_at":"2025-05-12T22:24:19.796Z","avatar_url":"https://github.com/guard.png","language":"Ruby","readme":"# Guard\n\n[![Gem Version](https://img.shields.io/gem/v/guard.svg?style=flat)](https://rubygems.org/gems/guard) [![Build Status](https://app.travis-ci.com/guard/guard.svg?branch=master)](https://app.travis-ci.com/guard/guard) [![Code Climate](https://codeclimate.com/github/guard/guard/badges/gpa.svg)](https://codeclimate.com/github/guard/guard) [![Test Coverage](https://codeclimate.com/github/guard/guard/badges/coverage.svg)](https://codeclimate.com/github/guard/guard) [![Inline docs](http://inch-ci.org/github/guard/guard.svg)](http://inch-ci.org/github/guard/guard) [![Reviewed by Hound](https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg)](https://houndci.com)\n\n\u003cimg src=\"http://f.cl.ly/items/0A0M3W2x3I1P450z341U/guard-Icon.png\" alt=\"Guard Icon\" align=\"right\" /\u003e\nGuard automates various tasks by running custom rules whenever file or directories are modified.\n\nIt'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.\n\nCommon 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.\n\nFor a full categorized list of known Guard plugins, look here: https://github.com/guard/guard/wiki/Guard-Plugins\n\nIf you have\nany questions about Guard or want to share some information with the Guard community, please go to one of\nthe following places:\n\n* [Guard Wiki](https://github.com/guard/guard/wiki)\n* [Google group](http://groups.google.com/group/guard-dev).\n* [StackOverflow](http://stackoverflow.com/questions/tagged/guard).\n* IRC channel `#guard` (irc.freenode.net) for chatting.\n\nBefore you file an issue, make sure you have read the _[known issues](#issues)_ and _[file an issue](#file-an-issue)_ sections that contains some important information.\n\n## Features\n\n* File system changes handled by our awesome [Listen](https://github.com/guard/listen) gem.\n* Support for visual system notifications.\n* Huge eco-system with [more than 300](https://rubygems.org/search?query=guard-) Guard plugins.\n* Tested against the latest Ruby 2.4.x, 2.5.x, 2.6.x, JRuby \u0026 Rubinius. See [`.travis-ci.yml`](https://github.com/guard/guard/blob/master/.travis.yml) for the exact versions.\n\n## Screencast\n\nTwo nice screencasts are available to help you get started:\n\n* [Guard](http://railscasts.com/episodes/264-guard) on RailsCast.\n* [Guard is Your Best Friend](http://net.tutsplus.com/tutorials/tools-and-tips/guard-is-your-best-friend) on Net Tuts+.\n\n## Installation\n\nThe simplest way to install Guard is to use [Bundler](http://bundler.io).\n\nAdd Guard (and any other dependencies) to a `Gemfile` in your project’s root:\n\n```ruby\ngroup :development do\n  gem 'guard'\nend\n```\n\nthen install it by running Bundler:\n\n```bash\n$ bundle\n```\n\nGenerate an empty `Guardfile` with:\n\n```bash\n$ bundle exec guard init\n```\n\nRun Guard through Bundler with:\n\n```bash\n$ bundle exec guard\n```\n\nIf you are on Mac OS X and have problems with either Guard not reacting to file\nchanges or Pry behaving strange, then you should [add proper Readline support\nto Ruby on macOS](https://github.com/guard/guard/wiki/Add-Readline-support-to-Ruby-on-Mac-OS-X).\n\n## Avoiding gem/dependency problems\n\n**It's important that you always run Guard through Bundler to avoid errors.**\n\nIf you're getting sick of typing `bundle exec` all the time, try one of the following:\n\n* (Recommended) Running `bundle binstub guard` will create `bin/guard` in your\n  project, which means running `bin/guard` (tab completion will save you a key\n  stroke or two) will have the exact same result as `bundle exec guard`.\n\n* Or, you can `alias be=\"bundle exec\"` in your `.bashrc` or similar and the execute only `be guard`.\n  **Protip**: It will work for all comands executed in `bundle exec` context!\n\n\n* Or, for RubyGems \u003e= 2.2.0 (at least, though the more recent the better),\n  simply set the `RUBYGEMS_GEMDEPS` environment variable to `-` (for autodetecting\n  the Gemfile in the current or parent directories) or set it to the path of your Gemfile.\n\n(To upgrade RubyGems from RVM, use the `rvm rubygems` command).\n\n*NOTE: this Rubygems feature is still under development still lacks many features of bundler*\n\n* Or, for RubyGems \u003c 2.2.0 check out the [Rubygems Bundler](https://github.com/rvm/rubygems-bundler).\n\n## Add Guard plugins\n\nGuard is now ready to use and you should add some Guard plugins for your specific use. Start exploring the many Guard\nplugins available by browsing the [Guard organization](https://github.com/guard) on GitHub or by searching for `guard-`\non [RubyGems](https://rubygems.org/search?utf8=%E2%9C%93\u0026query=guard-).\n\nWhen you have found a Guard plugin of your interest, add it to your `Gemfile`:\n\n```ruby\ngroup :development do\n  gem '\u003cguard-plugin-name\u003e'\nend\n```\n\nSee the init section of the Guard usage below to see how to install the supplied plugin template that you can install and\nto suit your needs.\n\n## Usage\n\nGuard is run from the command line. Please open your terminal and go to your project work directory.\n\nLook here for a full [list of Guard commands](https://github.com/guard/guard/wiki/List-of-Guard-Commands)\n\n### Start\n\nJust launch Guard inside your Ruby or Rails project with:\n\n```bash\n$ bundle exec guard\n```\n\nGuard will look for a `Guardfile` or `guardfile.rb` in your current directory. If it does not find one, it will look\nin your `$HOME` directory for a `.Guardfile`.\n\nPlease look here to see all the [command line options for Guard](https://github.com/guard/guard/wiki/Command-line-options-for-Guard)\n\n## Interactions\n\nPlease read how to [interact with Guard](https://github.com/guard/guard/wiki/Interacting-with-Guard) on the console and which [signals](https://github.com/guard/guard/wiki/Interacting-with-Guard#guard-signals) Guard accepts\n\n\n## Guardfile DSL\n\nFor details on extending your `Guardfile` look at [Guardfile examples](https://github.com/guard/guard/wiki/Guardfile-examples) or look at a list of commands [Guardfile-DSL / Configuring-Guard](https://github.com/guard/guard/wiki/Guardfile-DSL---Configuring-Guard)\n\n## Issues\n\nBefore reporting a problem, please read how to [File an issue](https://github.com/guard/guard/blob/master/CONTRIBUTING.md#file-an-issue).\n\n## Development / Contributing\n\nSee the [Contributing Guide](https://github.com/guard/guard/blob/master/CONTRIBUTING.md#development).\n\n## Releasing\n\n### Prerequisites\n\n* You must have commit rights to the GitHub repository.\n* You must have push rights for rubygems.org.\n\n### How to release\n\n1. Determine which would be the correct next version number according to [semver](http://semver.org/).\n1. Update the version in `./lib/guard/version.rb`.\n1. Commit the version in a single commit, the message should be \"Bump VERSION to X.Y.Z\".\n1. Push and open a pull request.\n1. Once CI is green, merge the pull request.\n1. 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](https://github.com/guard/guard/releases) .\n\n### Author\n\n[Thibaud Guillaume-Gentil](https://github.com/thibaudgg) ([@thibaudgg](https://twitter.com/thibaudgg))\n\n### Core Team\n\n* R.I.P. :broken_heart: [Michael Kessler](https://github.com/netzpirat).\n* [Rémy Coutable](https://github.com/rymai).\n* [Thibaud Guillaume-Gentil](https://github.com/thibaudgg) ([@thibaudgg](https://twitter.com/thibaudgg), [thibaud.gg](https://thibaud.gg/)).\n\n### Contributors\n\n[https://github.com/guard/guard/graphs/contributors](https://github.com/guard/guard/graphs/contributors)\n","funding_links":[],"categories":["Ruby","Testing","Workflow","Misc","File System Listener","Awesome Ruby CLIs","Libraries"],"sub_categories":["Continuous Testing","Visual Studio Code","Automation"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguard%2Fguard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fguard%2Fguard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguard%2Fguard/lists"}