rs-filewatch-trigger 0.1.0

FileWatch Trigger to run various actions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

# FileWatch Trigger

FileWatch Trigger application in Rust. The binary is named `fwt`.

The application watches for any type of file changes in the recursively watched
directory, and triggers the given action.

Currently able to perform the following action(s):

- Run shell template command with path and event

## How to install

You may also choose to visit
[releases](https://github.com/guangie88/rs-filewatch-trigger/releases)
and download the latest version of statically built binary in the zip asset.

Alternatively, if you have the `cargo` command, simply run

```bash
cargo install rs-filewatch-trigger
```

## Example Command

For help:

```bash
fwt -h
```

The following contains the help message:

```bash
USAGE:
    fwt [FLAGS] [OPTIONS] --path <path> <SUBCOMMAND>

FLAGS:
        --force-poll    Force using polling implementation, works for any platform
    -h, --help          Prints help information
        --relative      Use relative path instead of absolute path for path matches
    -V, --version       Prints version information
    -v, --verbose       Verbose mode (-v, -vv, -vvv)

OPTIONS:
    -d, --delay <delay_ms>     Delay interval in milliseconds between each file watch detection[default: 1000]
    -e, --event <event>        Event type to trigger on (0=NONE, 1=CREATED, 2=DELETED, 4=MODIFIED, 8=MOVED) [default: 1]
    -f, --filters <filters>    Glob pattern(s) for file matching (comma delimited) [default: *.*]
    -p, --path <path>          Directory path to watch recursive

SUBCOMMANDS:
    cmd     FileWatch Trigger to run various actions
    help    Prints this message or the help of the given subcommand(s)
```

### Shell template command action

Assuming the current working directory is `/home/xxx`:

```bash
fwt -e 15 \
    -f "*.jpg,*.png" \
    -p . \
    -v \
    cmd --print-stdout "echo {path}: {event}"
```

Example output:

```bash
/home/xxx/a.jpg: CREATED
```

The following contains the help message for this action:

```bash
USAGE:
    fwt --path <path> cmd [FLAGS] <cmd>

FLAGS:
    -h, --help            Prints help information
        --print-stderr    Prints shell stderr to main stderr
        --print-stdout    Prints shell stdout to main stdout
    -V, --version         Prints version information

ARGS:
    <cmd>    Shell template command to run with string interpolation ({path}: triggered file path) ({event}: event
             type number)
```