fsnotify

Cross-platform file system notifications for Go.

  • Owner: fsnotify/fsnotify
  • Platform:
  • License:: BSD 3-Clause "New" or "Revised" License
  • Category::
  • Topic:
  • Like:
    0
      Compare:

Github stars Tracking Chart

File system notifications for Go

GoDoc Go Report Card

fsnotify utilizes golang.org/x/sys rather than syscall from the standard library. Ensure you have the latest version installed by running:

go get -u golang.org/x/sys/...

Cross platform: Windows, Linux, BSD and macOS., Adapter, OS, Status, ---------------------, --------------------------------, -------------------------------------------------------------------------------------------------------------------------------, inotify, Linux 2.6.27 or later, Android*, Supported Build Status, kqueue, BSD, macOS, iOS*, Supported Build Status, ReadDirectoryChangesW, Windows, Supported Build Status, FSEvents, macOS, Planned, FEN, Solaris 11, In Progress, fanotify, Linux 2.6.37+, Planned, USN Journals, Windows, Maybe, Polling, All, Maybe, * Android and iOS are untested.

Please see the documentation and consult the FAQ for usage information.

API stability

fsnotify is a fork of howeyc/fsnotify with a new API as of v1.0. The API is based on this design document.

All releases are tagged based on Semantic Versioning. Further API changes are planned, and will be tagged with a new major revision number.

Go 1.6 supports dependencies located in the vendor/ folder. Unless you are creating a library, it is recommended that you copy fsnotify into vendor/github.com/fsnotify/fsnotify within your project, and likewise for golang.org/x/sys.

Contributing

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

Example

See example_test.go.

FAQ

When a file is moved to another directory is it still being watched?

No (it shouldn't be, unless you are watching where it was moved to).

When I watch a directory, are all subdirectories watched as well?

No, you must add watches for any directory you want to watch (a recursive watcher is on the roadmap #18).

Do I have to watch the Error and Event channels in a separate goroutine?

As of now, yes. Looking into making this single-thread friendly (see howeyc #7)

Why am I receiving multiple events for the same file on OS X?

Spotlight indexing on OS X can result in multiple events (see howeyc #62). A temporary workaround is to add your folder(s) to the Spotlight Privacy settings until we have a native FSEvents implementation (see #11).

How many files can be watched at once?

There are OS-specific limits as to how many watches can be created:

  • Linux: /proc/sys/fs/inotify/max_user_watches contains the limit, reaching this limit results in a "no space left on device" error.
  • BSD / OSX: sysctl variables "kern.maxfiles" and "kern.maxfilesperproc", reaching these limits results in a "too many open files" error.

Why don't notifications work with NFS filesystems or filesystem in userspace (FUSE)?

fsnotify requires support from underlying OS to work. The current NFS protocol does not provide network level support for file notifications.

Main metrics

Overview
Name With Ownerfsnotify/fsnotify
Primary LanguageGo
Program languageGo (Language Count: 2)
Platform
License:BSD 3-Clause "New" or "Revised" License
所有者活动
Created At2014-06-28 16:47:01
Pushed At2025-05-28 21:35:03
Last Commit At
Release Count42
Last Release Namev1.9.0 (Posted on 2025-04-04 16:14:13)
First Release Namev0.8.06 (Posted on )
用户参与
Stargazers Count10.1k
Watchers Count150
Fork Count0.9k
Commits Count616
Has Issues Enabled
Issues Count390
Issue Open Count24
Pull Requests Count167
Pull Requests Open Count4
Pull Requests Close Count135
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private