Robot
/
watchexec
mirror of https://github.com/watchexec/watchexec.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Executes commands in response to file modifications
53 Commits 12 Branches 263 Tags 13 MiB
Rust 99.6%
Shell 0.3%
Go to file
Matt Green ff7bb9bf45 Remove status section 2016-10-15 11:05:57 -04:00
ci Add CI scripts 2016-10-13 22:09:34 -04:00
pkg/brew Update Homebrew formula 2016-10-12 09:29:44 -04:00
src Ignore .DS_Store files by default 2016-10-13 20:23:38 -04:00
.gitignore Cargo.lock should be committed for apps 2016-10-13 20:26:32 -04:00
.travis.yml CI fun 2016-10-15 10:43:25 -04:00
Cargo.lock Drop regex dep 2016-10-14 09:33:23 -04:00
Cargo.toml Bump version to 1.0.0 2016-10-15 11:05:19 -04:00
LICENSE Create LICENSE 2016-09-18 16:43:26 -04:00
Makefile Add install/uninstall Makefile targets 2016-09-23 14:06:47 -06:00
README.md Remove status section 2016-10-15 11:05:57 -04:00
appveyor.yml Appveyor: build off of master 2016-10-15 11:03:48 -04:00

README.md

#watchexec

Software development often involves running the same commands over and over. Boring!

watchexec is a simple, standalone tool that watches a path and runs a command whenever it detects modifications.

Example use cases:

  • Automatically run unit tests
  • Run linters/syntax checkers

##Features

  • Simple invocation and use
  • Runs on OS X, Linux and Windows
  • Monitors current directory and all subdirectories for changes (use --watch to override)
    • Uses most efficient event polling mechanism for your platform (except for BSD)
  • Coalesces multiple filesystem events into one, for editors that use swap/backup files during saving
  • By default, uses .gitignore to determine which files to ignore notifications for
  • Support for watching files with a specific extension
  • Support for filtering/ignoring events based on glob patterns
  • Optionally clears screen between executions
  • Optionally restarts the command with every modification (good for servers)
  • Does not require a language runtime

##Anti-Features

  • Not tied to any particular language or ecosystem
  • Does not require a cryptic command line involving xargs

##Usage Examples

Watch all JavaScript, CSS and HTML files in the current directory and all subdirectories for changes, running make when a change is detected:

$ watchexec --exts js,css,html make

Watch all files below src and subdirectories for changes, running make test when a change is detected:

$ watchexec --watch src make test

Call make test when any file changes in this directory/subdirectory, except for everything below target:

$ watchexec -i target make

Call/restart python server.py when any Python file in the current directory (and all subdirectories) changes:

$ watchexec -e py -r python server.py

Run make when any file changes, using the .gitignore file in the current directory to filter:

$ watchexec make

##Installation

###OS X with Homebrew

$ brew install https://raw.githubusercontent.com/mattgreen/watchexec/master/pkg/brew/watchexec.rb

##Credits

  • notify for doing most of the heavy-lifting