1GUARD(1)                                                              GUARD(1)
2
3
4

NAME

6       guard - Guard keeps an eye on your file modifications.
7

DESCRIPTION

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

SYNOPSIS

13       guard <COMMAND> <OPTIONS>
14

COMMANDS

16   start
17       Starts Guard. This is the default command if none is provided.
18
19       The following options are available:
20
21       -c, --clear Clears the Shell after each change.
22
23       -n, --notify FLAG Disable notifications (Growl or  Libnotify  depending
24       on  your  system).  Notifications can be disabled globally by setting a
25       GUARD_NOTIFY environment variable to false. FLAG can be  true/false  or
26       t/f.
27
28       -g,  --group  GROUP1  GROUP2...  Scopes the Guard actions to the groups
29       specified by GROUP1, GROUP2, etc. Group names should  be  separated  by
30       spaces.  Plugins that don´t belong to a group are considered global and
31       are always run.
32
33       -P, --plugin PLUGIN1 PLUGIN2... Scopes the Guard actions to the plugins
34       specified by PLUGIN1, PLUGIN2, etc. Plugin names should be separated by
35       spaces.
36
37       -d, --debug Runs Guard in debug mode.
38
39       -w, --watchdir PATH Tells Guard to watch PATH instead of ./.
40
41       -G, --guardfile FILE Tells Guard to use FILE as its  Guardfile  instead
42       of ./Guardfile or ~/.Guardfile.
43
44       -i,  --no-interactions  Turn off completely any Guard terminal interac‐
45       tions.
46
47       -B, --no-bundler-warning Turn off warning when Bundler is not present.
48
49       -l, --latency Overwrite Listen´s default latency.
50
51       -p, --force-polling Force usage of the Listen polling listener.
52
53       -y, --wait-for-delay Overwrite Listen´s default wait_for_delay,  useful
54       for kate-like editors through ssh access.
55
56   init [GUARDS]
57       If  no  Guardfile is present in the current directory, creates an empty
58       Guardfile.
59
60       If GUARDS are present, add their default Guardfile configuration to the
61       current Guardfile. Note that GUARDS is a list of the Guard plugin names
62       without the guard- prefix. For instance to initialize guard-rspec,  run
63       guard init rspec.
64
65   list
66       Lists Guard plugins that can be used with the init command.
67
68   -T, show
69       List defined groups and Guard plugins for the current Guardfile.
70
71   -h, help [COMMAND]
72       List all of Guard´s available commands.
73
74       If COMMAND is given, displays a specific help for TASK.
75

EXAMPLES

77       Initialize Guard and a specific Guard plugin at the same time:
78
79       [bundle exec] guard init [rspec]
80
81       Run Guard:
82
83       [bundle  exec]  guard [start] --watchdir ~/dev --guardfile ~/env/Guard‐
84       file --clear --group backend frontend --notify false --debug
85
86       or in a more concise way:
87
88       [bundle exec] guard [start] -w ~/dev -G ~/env/Guardfile -c  -g  backend
89       frontend -n f -d
90

AUTHORS / CONTRIBUTORS

92       Thibaud Guillaume-Gentil is the main author.
93
94       A  list  of  contributors  based  on  all  commits  can  be found here:
95       https://github.com/guard/guard/contributors
96

CHANGELOG

98       The changelog can be found at: https://github.com/guard/guard/blob/mas‐
99       ter/CHANGELOG.md
100
101       This manual has been written by Remy Coutable.
102

WWW

104       http://guardgem.org/
105
106
107
108                                 November 2014                        GUARD(1)