# 見る miru - Simple dev server for command-line watchers ![](https://fat.gfycat.com/MaleSelfassuredBrahmanbull.gif) [![npm](https://img.shields.io/npm/v/miru.svg?maxAge=3600)](https://www.npmjs.com/package/miru) [![npm](https://img.shields.io/npm/dm/miru.svg?maxAge=3600)](https://www.npmjs.com/package/miru) [![npm](https://img.shields.io/npm/l/miru.svg?maxAge=3600)](https://www.npmjs.com/package/miru) ## Simple to use ```bash npm install -g miru # miru -w [ , ] miru --path public -w [ webpack -w src/app.js -o public/bundle.js, public/bundle.js ] ``` add `miru-connect.js` script to your index.html ( created by miru at start inside the `--path` directory or current working directory by default ) ```html ``` # About (Who watches the watchers?) A simple web server ( express and socket.io ) intended for running command-line watchers (daemon processes that watch and bundle source files and never exits). # Why Most bundlers are great at what they do and come with their own `--watch` modes ([rollup](https://github.com/rollup/rollup), [webpack](https://github.com/webpack/webpack), [stylus](https://github.com/stylus/stylus/) etc), they have great error parsing and do their specific thing very well. Miru embraces this, simply mirroring what they print to the terminal into the browser along with live reloading and some honey on top. # ...but why though? Because it reduces the contexts you're switching between by at least 1 (usually from 3 to 2). Without miru you'll have your eyes between your source code, your terminal running your watcher and the browser running your code. With miru your browser stays in sync with your terminal output, no longer do you have to double check the terminal to make sure your bundle was generated successfully or that an error occured during bundle generation. Live reloading is a nice plus. No need for browser extensions, allows for a nice dev experience across multiple devices, develop simultaneously against tablets, mobiles and desktop monitors. Miru simply spits the terminal output to the browser ( with some prettyfying and honey ) as well as cleaning up your command-line watchers into a concice, clear workflow. Keeping them nicely separate but also together. # For who? Probably people who prefer npm scripts over monolithic boilerplates and convoluted configs (not that there's anything wrong with boilerplates or configs, as long as they're well maintained, straightforward and clear!) # How miru simply runs commands, preferably npm scripts, as child_process.spawn's and attaches listeners to their std.out and std.err streams to figure out when various interesting events occur, such as successful builds, errors and crashes, additionally providing useful things like auto-recovery, live reloads and errors in the browser. miru creates a `miru-connect.js` file on startup in the `--path` directory (current working directory by default) that you link to in your index.html page. This script (miru-connect.js) simply connects to the miru express (w/ socket.io) server on port 4040 to listen for interesting events. miru serves the `-p, --path` directory but you'll probably want to run your own http server to serve your content and simply have the miru dev server (running on port 4040) available for the `miru-connect.js` script to connect to. # Sample index.html ```html Moon moon

``` # Arguments ```bash $ miru --help Usage: miru [options] Options: -p, --path Specify path (current directory by default) Usually path to public directory. This is also the path where miru creates "miru-connect.js" which you should