Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sharkdp/trigger
Run a user-defined command on file changes
https://github.com/sharkdp/trigger
inotify shell
Last synced: 3 months ago
JSON representation
Run a user-defined command on file changes
- Host: GitHub
- URL: https://github.com/sharkdp/trigger
- Owner: sharkdp
- License: mit
- Created: 2016-07-06T20:54:39.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-03-29T19:52:27.000Z (almost 5 years ago)
- Last Synced: 2024-11-04T22:37:10.457Z (3 months ago)
- Topics: inotify, shell
- Language: Shell
- Size: 11.7 KB
- Stars: 184
- Watchers: 10
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# trigger
``` bash
Usage: trigger COMMAND [FILE...]
```
trigger runs the given *COMMAND* every time one of the *FILE*s is changed.
If no *FILE* argument is given, trigger watches everything in the current
directory, recursively.
In the *COMMAND* string, `#1`, `#2`, .. can be used as synonyms for the
*FILE*names. The helper `tg COMMAND FILE ...` is a shortcut for
`trigger 'COMMAND #1' FILE ...`.
## Examples
### Make
Run `make` every time one of the files in the current directory changes:
```
trigger make
```
### Python
Run `python main.py` every time either `main.py` or `config.py` changes:
``` bash
trigger 'python #1' main.py config.py
```
By using the `tg` helper command, this can be shortened to:
``` bash
tg python main.py config.py
```
### Markdown to PDF
Convert a Markdown document to PDF every time it is changed. Combine this with
an auto-reloading PDF-viewer (e.g. okular) to get a live preview:
``` bash
tg 'pandoc -t latex -o README.pdf' README.md
```
### Less to CSS
Convert a LESS file to CSS:
``` bash
trigger 'lessc #1 > main.css' main.less
```
### Interrupt mode
If `trigger` is called with the `-i` (or `--interrupt`) option, it will kill
running subprocesses whenever a file changes:
``` bash
trigger -i longRunningCommand input.dat
```
## Requirements
trigger is just a simple wrapper around `inotifywait`. It should be available
for most Linux distributions (the package is typically called `inotify-tools`).
## Installation
Keeping in mind that, in principle, you should not copy-and-paste into your
shell, something like this should work:
``` bash
git clone https://github.com/sharkdp/trigger ~/.trigger
echo 'export PATH="$PATH:$HOME/.trigger"' >> .bashrc
```
## Related projects
Also have a look at these projects, to see if they fit your needs better:
- [http://entrproject.org/](http://entrproject.org/) - more features, slightly more complicated syntax
- [https://github.com/joh/when-changed](https://github.com/joh/when-changed) - different syntax, requires python and watchdog
- [https://facebook.github.io/watchman/](https://facebook.github.io/watchman/) - much more powerful but more complicated syntax.
- [http://inotify.aiken.cz/?section=incron&page=about](http://inotify.aiken.cz/?section=incron&page=about) - more difficult to setup up