A fast, small, lightweight filesystem monitor. Yellin' for changes!

API reference | Download (not yet)

Key Features

• Cross-platform (macOS, Linux, Windows)
• Glob pattern filtering
• Ignore hidden files
• Zero external dependencies

Installing

nimble install watchout

Examples

import watchout

let w = newWatchout("/path/to/watch")

w.onChange = proc(file: File) =
  echo "Changed: ", file.getName()

w.onDelete = proc(file: File) =
  echo "Deleted: ", file.getName()

w.start()

Pattern filtering

# Only watch .nim files
let w = newWatchout("/path/to/watch", some("*.nim"))

Multiple directories

let w = newWatchout(@["/path/a", "/path/b"], some("*.txt"))

Configure hidden file handling

let w = newWatchout("/path/to/watch")
w.ignoreHidden = false  # Include hidden files

Requirements

• Nim >= 2.0.0

Contributions & Support

• Found a bug? Create a new Issue
• Wanna help? Fork it!

License

Watchout MIT license.
Copyright © 2023 OpenPeeps & Contributors — All rights reserved.