@zthun/crumbtrail-cli 3.0.1 → 3.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +41 -6
- package/package.json +8 -9
package/README.md
CHANGED
|
@@ -1,17 +1,52 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @zthun/crumbtrail-cli
|
|
2
2
|
|
|
3
|
-
Crumbtrail
|
|
4
|
-
|
|
5
|
-
directory
|
|
3
|
+
Crumbtrail CLI provides command-line utilities for debugging file system
|
|
4
|
+
changes. It can watch a directory and log additions, removals, and updates, or
|
|
5
|
+
repeatedly refresh directory listings to help file changes become visible in
|
|
6
|
+
container-mounted directories.
|
|
6
7
|
|
|
7
8
|
## Installation
|
|
8
9
|
|
|
10
|
+
Requires Node.js 24.13.0 or later.
|
|
11
|
+
|
|
9
12
|
```sh
|
|
10
|
-
npm
|
|
13
|
+
npm install -g @zthun/crumbtrail-cli
|
|
11
14
|
```
|
|
12
15
|
|
|
13
16
|
## Usage
|
|
14
17
|
|
|
18
|
+
### Watch a directory
|
|
19
|
+
|
|
20
|
+
`watch` is the default command. Without a directory option, it watches the
|
|
21
|
+
current working directory.
|
|
22
|
+
|
|
23
|
+
```sh
|
|
24
|
+
crumbtrail-cli
|
|
25
|
+
crumbtrail-cli watch --directory /path/to/directory
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Use `-d` as a shorter form of `--directory`. Press Ctrl+C to stop watching.
|
|
29
|
+
|
|
30
|
+
### Refresh directory listings
|
|
31
|
+
|
|
32
|
+
The `nudge` command repeatedly reads the target directory's parent directory.
|
|
33
|
+
This can help refresh file change visibility in Docker mounts on non-Linux
|
|
34
|
+
hosts. It refreshes listings rather than modifying directory timestamps.
|
|
35
|
+
|
|
15
36
|
```sh
|
|
16
|
-
crumbtrail-cli /path/to/directory
|
|
37
|
+
crumbtrail-cli nudge --directory /path/to/directory
|
|
38
|
+
crumbtrail-cli nudge --directory /path/to/directory --recursive --every 2000 --silent
|
|
17
39
|
```
|
|
40
|
+
|
|
41
|
+
| Option | Description | Default |
|
|
42
|
+
| ------------------------ | -------------------------------------------- | ------------------------- |
|
|
43
|
+
| `-d, --directory <path>` | Directory to refresh. | Current working directory |
|
|
44
|
+
| `--recursive` | Also scan subdirectories. | Disabled |
|
|
45
|
+
| `-e, --every <ms>` | Interval between refreshes, in milliseconds. | `1500` |
|
|
46
|
+
| `--silent` | Suppress log output. | Disabled |
|
|
47
|
+
|
|
48
|
+
Press Ctrl+C to stop nudging. Recursive scans can increase CPU usage in large
|
|
49
|
+
directory trees.
|
|
50
|
+
|
|
51
|
+
Use `crumbtrail-cli --help`, `crumbtrail-cli watch --help`, or
|
|
52
|
+
`crumbtrail-cli nudge --help` to list commands and options.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@zthun/crumbtrail-cli",
|
|
3
|
-
"version": "3.0.
|
|
3
|
+
"version": "3.0.4",
|
|
4
4
|
"description": "An application for crumbtrail that helps with debugging io issues",
|
|
5
5
|
"author": "Anthony Bonta",
|
|
6
6
|
"license": "MIT",
|
|
@@ -23,23 +23,22 @@
|
|
|
23
23
|
"access": "public"
|
|
24
24
|
},
|
|
25
25
|
"dependencies": {
|
|
26
|
-
"@zthun/crumbtrail-fs": "^3.0.
|
|
27
|
-
"@zthun/lumberjacky-log": "^4.0.
|
|
26
|
+
"@zthun/crumbtrail-fs": "^3.0.4",
|
|
27
|
+
"@zthun/lumberjacky-log": "^4.0.12",
|
|
28
28
|
"commander": "^15.0.0"
|
|
29
29
|
},
|
|
30
30
|
"devDependencies": {
|
|
31
|
-
"@zthun/janitor-build-config": "^21.1.3",
|
|
32
31
|
"@zthun/janitor-ts-config": "^21.1.3",
|
|
33
|
-
"@zthun/janitor-vite": "^21.
|
|
34
|
-
"tsx": "^4.23.
|
|
32
|
+
"@zthun/janitor-vite": "^21.2.5",
|
|
33
|
+
"tsx": "^4.23.15",
|
|
35
34
|
"typescript": "^6.0.3",
|
|
36
|
-
"vite": "^8.
|
|
37
|
-
"vitest": "^
|
|
35
|
+
"vite": "^8.3.4",
|
|
36
|
+
"vitest": "^5.0.4",
|
|
38
37
|
"vitest-mock-extended": "^5.1.1"
|
|
39
38
|
},
|
|
40
39
|
"files": [
|
|
41
40
|
"dist"
|
|
42
41
|
],
|
|
43
42
|
"sideEffects": false,
|
|
44
|
-
"gitHead": "
|
|
43
|
+
"gitHead": "c21aa627285d2671e97aa7f8df70a75d7ffbcb29"
|
|
45
44
|
}
|