https://github.com/vimist/watch-do
A command line tool to watch files and run arbitrary commands when they change
https://github.com/vimist/watch-do
Last synced: 3 months ago
JSON representation
A command line tool to watch files and run arbitrary commands when they change
- Host: GitHub
- URL: https://github.com/vimist/watch-do
- Owner: vimist
- Created: 2016-08-03T11:41:39.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2020-06-02T19:22:19.000Z (about 6 years ago)
- Last Synced: 2025-12-16T16:11:23.447Z (6 months ago)
- Language: Python
- Size: 86.9 KB
- Stars: 7
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Documentation build, test and linting for `master` branch:
[](https://travis-ci.org/vimist/watch-do)
[](https://lima.codeclimate.com/github/vimist/watch-do/coverage)
[](https://lima.codeclimate.com/github/vimist/watch-do)
Watch Do
========
Watch Do is primarily a command line utility that allows you to monitor files
for changes and then perform actions based on these changes.
Installation
------------
To install Watch Do, ensure you have pip installed using your distributions
package manager and then run the following command:
```sh
pip install watch-do
```
Basic Usage
-----------
You can start making use of Watch Do right away! A basic Watch Do command can
be seen below, this watches all `.py` files recursively using the default
watcher (`ModificationTime`) and then runs `make test` in the directory that
Watch Do was launched in.
```sh
watch-do -w '**/*.py' -d 'make test'
```
Run `watch-do --help` for more information on what all of the different
command line switches do.
**Note:**
The `-r` (`--reglob`) switch is often useful to maintain an up-to-date list of
files that trigger the doers to run.
Documentation
-------------
You can run the following command to find more information on the modules the
Watch Do package provides:
```sh
make serve-docs
```