Skip to content

Configuration files

Jump to bottom Edit New page
Justin MacCarthy edited this page Aug 23, 2021 · 2 revisions

Files used by Guard

Project-specific Guard DSL files:

Guardfile (in current directory) - can contain DSL statements, evaluated by Guard during startup

.Guardfile (in current directory) - if it exists, it is used instead of the Guardfile

Global Guard DSL files:

~/.guard.rb (in home directory) - can contain DSL statements. If it exists, it is always evaluated by Guard (before evaluating the project-specific DSL).

Pry-only config

Guard supports the XDG_CONFIG_HOME environment value if it is set .

~/.guardrc (in home directory) - if it exists, it is evaluated by the Pry interator (and should not contain DSL statements)

This wiki and the Guard README document contain a lot of information, please take your time and read these instructions carefully.

If you run into any trouble, you may start by understanding how Guard works.

We provide detailed changes for each Guard release.

Be sure to read the CONTRIBUTING guidelines before reporting a new Guard issue or open a pull request.

If you have any questions about the Guard usage or want to share some information with the Guard community, please go to one of the following places:

Add a custom sidebar
Clone this wiki locally