Package Exports

serve/bin/serve
serve/bin/serve.js
serve/lib/server

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (serve) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

serve

Ever wanted to share a certain directory on your network by running just a command? Then this module is exactly what you're looking for: It provides a neat interface for listing the directory's contents and switching into sub folders.

In addition, it's also awesome when it comes to serving static sites. If a directory contains an index.html, serve will automatically render it instead of serving the file's content as plaintext.

screenshot

Usage

Install it (needs at least Node LTS):

npm install -g serve

And run this command in your terminal:

serve <path> [options]

Options

Run this command to see a list of all available options:

serve help

Authentication

If you set the --auth flag, the package will look for a username and password in the SERVE_USER and SERVE_PASSWORD environment variables.

Contributing

Fork this repository to your own GitHub account and then clone it to your local device
Uninstall serve if it's already installed: npm uninstall -g serve
Link it to the global module directory: npm link

After that, you can use the serve command everywhere. Here's a list of issues that are great for beginners.

Credits

This project used to be called "list". But thanks to TJ Holowaychuk handing us the new name, it's now called "serve" (which is much more definite).

Author

Leo Lamprecht (@notquiteleo) - ▲ZEIT