The spy package

[Tags: bsd3, program]

Spy can be used to watch for file changes and to either report the modified files or run a command if files change. It can be used to trigger compilation, to run tests or start a deployment.


[Skip to ReadMe]

Properties

Versions0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 0.10
Change logNone available
Dependenciesbase (>=3 && <5), cmdargs (>=0.10), directory (>=1.1), filemanip (>=0.3.6.2), filepath (>=1.3), fsnotify (>=0.0.4), json (>=0.7), process (>=1.1), system-filepath (>=0.4.7), time (>=1.4) [details]
LicenseBSD3
AuthorStefan Saasen
Maintainerstefan@saasen.me
CategoryDevelopment
Home pagehttps://bitbucket.org/ssaasen/spy
Bug trackerhttps://bitbucket.org/ssaasen/spy/issues
Source repositoryhead: git clone git@bitbucket.org:ssaasen/spy.git
Executablesspy
UploadedThu Jan 3 09:21:19 UTC 2013 by StefanSaasen
Downloads1058 total (42 in last 30 days)
Votes
0 []
StatusDocs not available [build log]
All reported builds failed as of 2015-06-08 [all 2 reports]

Flags

NameDescriptionDefaultType
small_baseChoose the new, split-up base package.EnabledAutomatic

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainers' corner

For package maintainers and hackage trustees

Readme for spy-0.7

Spy

Spy is a compact file system watcher for Mac OS X and Linux (Note: Should work on Windows but is currently untested).

Usage

Spy expects a single argument, the directory or a single file to watch. Spy currently supports two different modes: watch and run mode.

Watch mode

In output mode Spy will print the path to a modified file to STDOUT (followed by a newline) whenever a file modification (new file added, file modified, file deleted) occurs.

$> spy watch .
path/to/modified/file

Because watch is the default mode you can omit the watch command if you want:

$> spy .

It's possible to watch a single file (this obviously only shows changes to that particular file):

$> spy /path/to/file

The default format is the full path to the modified file followed by a newline. To make it easier to parse the output, the --format=json changes the output to be printed formatted as a JSON object (again followed by a newline).

$> spy watch --format=json .
{"path":"/path/to/modified.file","flag":"Added","time":"2012-12-20 11:26:56.859456 UTC"}

Flag is one of "Added", "Modified", "Removed".

For directories the following options apply:

An optional second argument can be used to filter the files in the given directory using a glob pattern:

$> spy watch /path/to/directory "*.md"

Run mode

In run mode Spy will execute a given command whenever a file modification occurs without printing modifications to stdout. The command will be executed with the path to the modified file as the last argument.

$> spy run "./run-build.sh"

In the example above the shell script run-build.sh would be executed with the path to the modified file as the first argument.

If the command to be executed does not expect any (additional) arguments the --notify-only flag can be used. This will cause spy to execute the command without passing the path as an argument:

$> spy run --notify-only "rake test" .

To compile Spy for example use:

$> spy run -n "cabal build" src

Installation

Binary distribution

The binary distribution contains a 64bit binary compiled for Mac OS X or Linux.

Download the tarball from https://bitbucket.org/ssaasen/spy/downloads and run "make install" to copy the binary and the man page into the correct target directories:

$> curl -OL https://bitbucket.org/ssaasen/spy/downloads/spy-PLATFORM-ARCH-VERSION.tar.gz
$> tar xfz spy-PLATFORM-ARCH-VERSION.tar.gz
$> cd spy
$> make install

The user manual should now be available via man spy and the spy executable should be on your $PATH.

Source distribution

You need the Haskell platform installed and cabal-install available on your $PATH.

To install spy from hackage simply run:

$> cabal install spy

Done!

To install spy from git you need the Haskell platform installed and cabal-install available on your $PATH:

$> git@bitbucket.org:ssaasen/spy.git
$> cd spy
$> cabal install --only-dependencies
$> cabal configure
$> cabal build

This will create the spy binary in the ./dist/build/spy directory.

To copy the spy binary to the cabal bin directory (which should be available on your PATH) use:

$> cabal copy