# inotify-logger

> Log inotify events in a friendly way

## Features

- Recursively watches existing and newly added files and directories in the current directory.
- Groups `MOVED_FROM` and `MOVED_TO`events into a single `MOVE` event when possible.
- Prints only a (currently hard-coded) subset of inotify events, for ease of reading.
- Prints an inactivity ruler after one second with no new events, visually grouping events.

![Screenshot of inotify-logger in a terminal](./docs/terminal-screenshot.png)

## Installation and Usage

After obtaining a working [Rust toolchain](https://www.rust-lang.org/tools/install), inotify-logger can be installed from source through [crates.io](https://crates.io/crates/inotify-logger/):

```sh
cargo install --locked inotify-logger
```

It can then be started in the directory to watch for events:

```sh
inotify-logger
```

## Configuration

inotify-logger does not currently feature any configuration.
It *may* later support configuring parts of its behavior through command-line arguments.

## Compatibility

The console output is not intended for machine consumption and no compatibility guarantees are provided.

## License

Copyright 2024 AudaciousAxiom

This project is licensed under MPL-2.0.