Skip to content

Latest commit

 

History

History
60 lines (38 loc) · 1.84 KB

README.md

File metadata and controls

60 lines (38 loc) · 1.84 KB
Raw

File Watcher CLI Tool

This CLI tool watches a specified file or directory for changes and executes a given command whenever a change is detected. It uses the fsnotify package to monitor file system events and supports debouncing to prevent multiple rapid executions of the command.

Installation

To install the tool, you need to have Go installed on your system. Then, you can build the tool using the following commands:

git clone [email protected]/comfucios/file-watcher
cd file-watcher
go build -o file-watcher

Alternatively, you can download the pre-built artifact from the latest release on GitHub that matches your OS and CPU architecture. Untar the downloaded file and use the extracted file-watcher file in the folder you extracted:

# Download the latest release artifact
curl -L -o file-watcher.tar.gz https://github.com/comfucios/file-watcher/releases/latest/download/file-watcher-darwin-amd64.tar.gz

# Extract the tar file
tar -xzf file-watcher.tar.gz

# Use the extracted file-watcher
./file-watcher --version

Usage

The tool requires two flags: --source and --action.

  • --source: The source file or directory to watch.
  • --action: The CLI command to execute when a change is detected.

Example

Watch a directory and execute a command when a change is detected:

./file-watcher --source /path/to/directory --action "echo 'Directory changed!'"

Watch a file and execute a command when a change is detected:

./file-watcher --source /path/to/file.txt --action "echo 'File changed!'"

Notes

  • The tool supports debouncing with a 500-millisecond delay to prevent multiple rapid executions of the command.
  • The tool will monitor the specified directory and all its subdirectories.

License

This project is licensed under the MIT License - see the LICENSE file for details.