node package manager
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

micro-list

micro-list

Build Status XO code style Slack Channel

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, micro-list will automatically render it instead of serving the file's content as plaintext.

Powers now-serve.

Usage

Install it (needs at least node v6)

$ npm install -g micro-list

Run it

$ list [options] <path>

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 micro-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

Contribute

  1. Fork this repository to your own GitHub account and then clone it to your local device
  2. Uninstall now-serve if it's already installed: npm uninstall -g micro-list
  3. Link it to the global module directory: npm link
  4. Transpile the source code and watch for changes: npm start

Yey! Now can use the list command everywhere.