File system notifications for Go

Go 1.3+ required.

Cross platform: Windows, Linux, BSD and OS X.

Adapter	OS	Status
inotify	Linux, Android*	Supported
kqueue	BSD, OS X, iOS*	Supported
ReadDirectoryChangesW	Windows	Supported
FSEvents	OS X	Planned
FEN	Solaris 11	Planned
fanotify	Linux 2.6.37+
USN Journals	Windows	Maybe
Polling	All	Maybe

* Android and iOS are untested.

Please see the documentation for usage. Consult the Wiki for the FAQ and further information.

API stability

Two major versions of fsnotify exist.

fsnotify.v0 is API-compatible with howeyc/fsnotify. Bugfixes may be backported, but I recommend upgrading to v1.

import "gopkg.in/fsnotify.v0"

* Refer to the package as fsnotify (without the .v0 suffix).

fsnotify.v1 provides a new API based on this design document. You can import v1 with:

import "gopkg.in/fsnotify.v1"

Further API changes are planned, but a new major revision will be tagged, so you can depend on the v1 API.

Master may have unreleased changes. Use it to test the very latest code or when contributing, but don't expect it to remain API-compatible:

import "github.com/go-fsnotify/fsnotify"

Contributing

Please refer to CONTRIBUTING before opening an issue or pull request.

Example

See example_test.go.

Related Projects

• notify
• fsevents