wrun

README

wrun

wrun is an inotify-based CLI that runs specified commands whenever the contents in the current directory change.

Building

You can download the binary available on the releases page or clone this repo and run make.

Completion

Just add one of the following lines to your .bashrc or .zshrc:

# .bashrc
source <(wrun completion bash)

# .zshrc
source <(wrun completion zsh)

Watched events

The following events are watched: IN_CREATE, IN_DELETE, IN_CLOSE_WRITE, IN_MOVED_FROM, IN_MOVED_TO. To learn more about the inotify API, click here.

Using

To start watching, run wrun start in the directory to be watched. Note that this directory needs to have a config file.

Config file

The easiest way to create a config file(wrun.yaml) is by running wrun init, which will create a config file in the current directory with all of the options set to their respective default values.

Some properties exist both globally and per command (e.g. delayToKill and fatalIfErr). The command version, if exists, always takes precedence over the global version.

delayToKill

The time in milliseconds to wait after sending a SIGINT and before sending a SIGKILL to a command. Defaults to 1000.

fatalIfErr

Whether to skip subsequent commands in case the current one returns an error. Defaults to false.

ignoreRegExps

List of regular expressions to ignore. Any file/directory starting with . or ending with wrun.yml or wrun.yaml is always ignored. To learn more about the syntax of the regular expressions, click here. Every directory path matched against these regular expressions ends with a /.

cmds

List of commands to be executed sequentially.

cmd.fatalIfErr

The same as the global version, except that it is command-wide.

cmd.delayToKill

The same as the global version, except that it is command-wide.

cmd.terms

The terms of the command, also known as arguments. The first term is always the command's name. For example, the terms for

touch a.txt

are

["touch", "a.txt"]

It's common to think of terms as the line that runs the command splitted by spaces, which is true, except if you want to provide a string with more than one word as an argument. For example

grep "some phrase here" file.txt

has a different list of terms than:

grep some phrase here file.txt

In the former, the list of terms is ["grep", "some phrase here", "file.txt"]), and the grep command receives two arguments. In the latter, the list of terms is ["grep", "some", "phrase", "here", "file.txt"]), and the grep command receives four arguments.