serve

Simple 5 minute command-line file / directory server built with connect, inspired by nodejitsu's http-server to show off the simplicity and flexibility of connect as a modular server.

Installation

$ npm install -g serve

Usage

Usage: serve [options] [dir]

Options:

  -v, --version        output the version number
  -F, --format <fmt>   specify the log format string
  -p, --port <port>    specify the port [3000]
  -f, --favicon <path> serve the given favicon
  -H, --hidden         enable hidden file serving
  -C, --cors           allows cross origin access serving
  -S, --no-stylus      disable stylus rendering
  -J, --no-jade        disable jade rendering
      --no-less        disable less css rendering
  -I, --no-icons       disable icons
  -L, --no-logs        disable request logging
  -D, --no-dirs        disable directory serving
      --compress       gzip or deflate the response
      --exec <cmd>     execute command on each request
  -h, --help           output usage information

Examples

HTTP Accept support built into connect.directory():

 $ curl http://local:3000/ -H "Accept: text/plain"
 bin
 History.md
 node_modules
 package.json
 Readme.md

Requesting a file:

$ curl http://local:3000/Readme.md

 # serve
 ...

Requesting JSON for the directory listing:

$ curl http://local:3000/ -H "Accept: application/json"
["bin","History.md","node_modules","package.json","Readme.md"]

Directory listing served by connect's connect.directory() middleware.

License

(The MIT License)

Copyright (c) 2011 TJ Holowaychuk <tj@vision-media.ca>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.