lr

Livereload interface for hackers

npm install lr
4 downloads in the last day
17 downloads in the last week
60 downloads in the last month

lr

Livereload is an amazing tool comprised of many somewhat half-baked components. This project provides a high-level abstaction of livereload so developers can accomplish much more with it.

Installation

npm install -g lr

Features

  • reload static assets without refreshing
  • watch files and directories, triggering tasks on changes
  • make-like configurations with .lr.yml
  • control task execution styles with configurable delimiters (see mute)

Usage

From --help:

Usage: lr [options] [path]:[command] ...

Options:

  -h, --help         output usage information
  -V, --version      output the version number
  -p, --port <port>  listen on port
  -m, --mute <char>  character to suppress reloading
  -f, --file <path>  path to configuration file
  -v, --verbose      more detailed log messages
  -s, --silent       suppress all log messages

Tasks

[path]

Watch the path and reload on changes. All watches are recursive.

Examples:

$ lr            # this is the same as passing `.`
$ lr foo bar    # pass as many paths as you like
$ lr foo/*.js   # globs are resolved

[path]:[command]

If given a command, lr will execute it before reloading. This is particularly useful for builds.

Examples:

$ lr baz:make   # when baz changes, make, then reload

[path]:[[mute]command]

Mute commands are prefixed by the mute delimiter, @, by default.

A mute command does not trigger a reload. This is handy for builds with multiple compile steps. For instance, you may want to compile your stylus files quietly, instead waiting for changes in build before reloading.

Examples:

$ lr public/*/*.styl:'@make stylus' build  # compile CSS when necessary, but only reload for changes in build

Todo

  • tests
  • docs on config files

License

MIT

npm loves you