Skip to content

Latest commit

 

History

History
96 lines (65 loc) · 2.07 KB

README.md

File metadata and controls

96 lines (65 loc) · 2.07 KB
Raw

cocur/watchman

PHP wrapper for facebook/watchman.

Latest Stable Version Build Status Code Coverage

Features

  • Simple PHP wrapper for facebook/watchman
  • Add, list and delete watched directories
  • Add, list and delete triggers
  • Compatible with PHP >= 5.4 and HHVM

Installation

You can install cocur/watchman through Composer:

$ composer require cocur/watchman:@stable

In a production environment you should replace @stable with the version you want to use.

Usage

use Cocur\Watchman\Watchman;

$watchman = new Watchman();
$watch = $watchman->addWatch('/var/www/foobar');
$trigger = $watch->addTrigger('foo', '*.js', 'ls -al');

// Retrieve all watched directories
$watched = $watchman->listWatches();

// Retrieve all triggers from a watch
$triggers = $watch->listTriggers();

// Later...
$trigger->delete();
$watch->delete();

Supported Watchman commands

  • watch ✓
  • watch-list ✓
  • watch-del ✓
  • clock ✓
  • trigger ✓
  • trigger-list ✓
  • trigger-del ✓
  • find ✓
  • query ✓
  • since ✓
  • log-level ✓
  • log ✓
  • shutdown-server ✓
  • subscribe
  • unsubscribe
  • get-sockname ✓

Changelog

Version 0.1 (27 April 2014)

  • Initial release
  • Add, delete and list watched directories
  • Add, delete and list triggers

Author

Florian Eckerstorfer

License

The MIT license applies to cocur/watchman. For the full copyright and license information, please view the LICENSE file distributed with this source code.