Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Guard extension to run cli processes
tag: v1.0.4

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib/guard
test
.gitignore
.travis.yml
Gemfile
Guardfile
LICENSE
README.md
Rakefile
Vagrantfile
guard-process.gemspec
vagrant-provision

README.md

Guard::Process Build Status

Guard to run continues processes.

This gem requires Ruby 1.9.2, 1.9.3 or JRuby in 1.9 mode.

Usage

Please read the Guard documentation to learn how to use Guard.

There is also an exellent screencast available on Railscasts

Additionally there is a great introductory article on Intridea Blog mentioning Guard::Process.

Guardfile

You can add as many process Guards as you want, an example Guardfile:

  guard 'process', :name => 'EndlessRunner', :command => 'rails runner Something::ThatGoesOnAndOn' do
    watch('Gemfile.lock')
  end

  guard 'process', :name => 'AnotherRunner', :command => 'rails runner AnotherRunner' do
    watch('Gemfile.lock')
  end

Options

The following options are available:

  • name The display name of your process in Guard, this is shown when Guard::Process is starting and stopping your process
  • command The command to run as you would run it from the command line
  • dir The directory in which you want to run the command, if none is given then Ruby's current working directory is used
  • stop_signal The signal that Guard::Process sends to terminate the process when it needs to stop/restart it. This defaults to 'TERM' (in some cases you may need KILL).
  • env A Hash with environmental variables to set for the context where your command runs, like so:
  {"SSL_CERTS_DIR" => "/etc/ssl/certs", "JAVA_HOME" => "/usr/local/java"}

Changes

1.0.4

  • Adds the dir option

Development

Pull requests are welcome, please make sure your patches are well tested before contributing. When sending a pull request:

  • Use a topic branch for your change
  • Add tests for your changes using MiniTest::Unit
  • Do not change the version number in the gemspec

License

Guard::Process is released under the MIT license.

Author

Mark Kremer

Something went wrong with that request. Please try again.