You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Zippy: A file-watching CLI for faster edit–build–run loops
1
+
# Zippy: A file-watching CLI for faster edit-build-run loops
2
2
3
-
Zippy is a lightweight CLI that watches a file or directory and reruns your command the moment you save. It keeps your stdout clean, logs to stderr with levels, and stays out of your way during the edit–build–run loop.
3
+
Zippy is a lightweight Linux CLI that watches a file or directory and reruns your command the moment you save. It’s ideal for C++ development, letting you see the impact of your changes immediately without waiting for a full build.
4
4
5
5
## Quick start
6
6
7
7
```bash
8
-
#Run from source (Linux/Arch):
8
+
#Build from source
9
9
make build
10
-
zig build run -- path/to/file-or-dir
10
+
11
+
# Run from the local build
12
+
./src/build/zippy ./path/to/file-or-dir
11
13
12
14
# Install it globally
13
-
sudo make install # /usr/local on Linux | %LOCALAPPDATA%/Programs/zippy on Windows
14
-
sudo make install PREFIX=$HOME/.local # user-local
15
+
sudo make install
16
+
17
+
# Or install for your user only
18
+
make install PREFIX=$HOME/.local
15
19
16
-
# Run zippy!
20
+
# Run zippy after install
17
21
zippy ./path
18
22
```
19
23
@@ -26,50 +30,52 @@ Zippy loads `Zippy.json` from the current working directory:
26
30
"delay": 1000000,
27
31
"ignore": [],
28
32
"save_log": false,
33
+
"log_path": "zippy.log",
29
34
"cmd": "make && ./build/out"
30
-
// OR
31
-
"cmd": "node index.js"
32
35
}
33
36
```
34
37
35
-
-`delay` (microseconds): debounce between change checks (default: 1_000_000).
36
-
-`ignore`: reserved for future ignore patterns.
37
-
-`cmd`: command to execute when changes occur. Placeholders: `{file}` (changed file or watched dir), `{dir}` (watched directory).
38
-
-`save_log` (bool): when true, also write logs to `log_path` (default: `false`).
39
-
-`log_path` (string): path to the log file when `save_log` is true (default: `zippy.log`).
40
-
When `save_log=true`, child command stdout/stderr is tee’d into the same log.
38
+
-`delay` (microseconds): debounce between checks. Default: `1000000`.
39
+
-`ignore`: parsed for compatibility and future use; currently not applied.
40
+
-`cmd`: command to run when a change is detected. Placeholders: `{file}` and `{dir}`.
41
+
-`save_log`: when `true`, append Zippy logs and child output to `log_path`.
42
+
-`log_path`: log file path used when `save_log=true`. Default: `zippy.log`.
41
43
42
-
Generate a starter config:`zippy --generate`.
44
+
Generate a starter config with`zippy --generate`.
43
45
44
46
## CLI commands
45
47
46
48
-`--help` show help
47
49
-`--version` print version
48
-
-`--commands` list commands
49
-
-`--config` show config help
50
-
-`--log` print the configured log file (when `save_log=true`; includes child output)
51
-
-`--clear` truncate the configured log file (when `save_log=true`)
50
+
-`--config` print the active config summary
51
+
-`--log` print the configured log file when `save_log=true`
52
+
-`--clear` truncate the configured log file when `save_log=true`
0 commit comments