list
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, list will automatically render it instead of serving the file's content as plaintext.
Usage
Install it (needs at least node v6)
$ npm install -g listRun it
$ list <path> [options]You can find a list of all options below.
Options
| Usage | Description | Default value |
|---|---|---|
| -h, --help | Output all available options | - |
| -v, --version | The version tag of the list instance on your device | - |
| -p, --port [port] | A custom port on which the app will be running | 3000 |
| -c, --cache [seconds] | How long static files should be cached in the browser | 3600 |
| -s, --single | Serve single page apps with only one index.html in the root directory |
- |
| -u, --unzipped | Disable gzip compression | false |
Examples
Here's a list of selected sites that are running on list:
Contribute
- Fork this repository to your own GitHub account and then clone it to your local device
- Uninstall list if it's already installed:
npm uninstall -g list - Link it to the global module directory:
npm link - Transpile the source code and watch for changes:
npm start
Yey! Now can use the list command everywhere.