watchman README

The project's README from github.com/facebook/watchman. As one markdown file: README.md.

watchman-logo

Watchman

A file watching service.

Purpose

Watchman exists to watch files and record when they actually change. It can also trigger actions (such as rebuilding assets) when matching files change.

Documentation

Head on over to https://facebook.github.io/watchman/

License

Watchman is made available under the terms of the MIT License. See the LICENSE file that accompanies this distribution for the full text of the license.

Support

Watchman is primarily maintained by the source control team at Meta Platforms, Inc. We support:

Support for additional operating systems, release packaging, and language bindings is community-maintained:

Please submit a GitHub issue to report any troubles.

Contributing

Please see the contributing document.

watchman (facebook/watchman)

Searching Database…

13.7K ·GitHub
What is this?Watchman is a file watching service: it watches your files and records when they actually change.
Is it a background service, or a library I link into my app?It's a service: a daemon watches the filesystem while you interact with it from the command line or through client libraries.
How do I get it installed?On macOS the easiest route is Homebrew: brew install watchman. Meta ships supported builds for Windows, macOS, and Linux, and the repo includes a Makefile for building from source.
Which languages can I use it from?Official clients exist for Python, Rust, and JavaScript; other language bindings are community-maintained.
Is support the same on every platform?No — Meta officially supports Windows, macOS, and Linux builds on recent Ubuntu and Fedora only; Homebrew packaging, FreeBSD, and Solaris are community-maintained.
Can I use it in my own project for free?Yes — it is open source under the MIT License, so personal and commercial use are both fine.
Is Watchman a new experiment or an established tool?Established: the GitHub repo dates back to 2012, has about 13.7k stars, and is maintained by Meta's source control team — long-running, widely used developer infrastructure.
Creator
facebook
Size
34.3 MB
Stars
13.7K
Age
13y
Commits · 90 Days