# gr-watchman

> Bindings for the Watchman file watching service

Latest version **2.2.2** (published 2024-03-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install gr-watchman
pnpm add gr-watchman
yarn add gr-watchman
bun add gr-watchman
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.2.2 |
| Published | 2024-03-15 |
| First published | 2024-03-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 10.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Wez Furlong |
| Maintainers | galerirakian |
| Keywords | galerirakian, watchman, file, watch, watcher, watching, fs.watch, fswatcher, fs, glob, utility |

## Links

- npm: https://www.npmjs.com/package/gr-watchman
- Repository: git@github.com:galerirakian/watchman
- Homepage: https://rakian.id/
- Issues: https://github.com/galerirakian/watchman/issues
- npm.io page: https://npm.io/package/gr-watchman

## Dependencies (1)

- [bser](https://npm.io/package/bser.md) 2.1.1

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 2.2.2 (latest) — 2024-03-15
- 2.1.2 — 2024-03-15

## README

# gr-watchman

`gr-watchman` is a filesystem watcher that uses the
[Watchman](https://rakian.id) file watching service from
Facebook.

Watchman provides file change notification services using very
efficient recursive watches and also allows more advanced change matching and
filesystem tree querying operations using
[a powerful expression syntax](https://rakian.iddocs/file-query.html#expressions).

## Install

You should [install Watchman](
https://rakian.iddocs/install.html) to make the most of this
module.

Then simply:

```
$ npm install gr-watchman
```

## Key Concepts

- Watchman recursively watches directories.
- Each watched directory is called a `root`.
- You must initiate a `watch` on a `root` using the `watch-project` command prior to subscribing to changes
- Rather than separately watching many sibling directories, `watch-project` consolidates and re-uses existing watches relative to a project root (the location of your `.watchmanconfig` or source control repository root)
- change notifications are relative to the project root

## How do I use it?

[Read the NodeJS watchman documentation](https://rakian.iddocs/nodejs.html)

---
_Source: https://npm.io/package/gr-watchman · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._