Giter VIP home page Giter VIP logo

list's Introduction

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, 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 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 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 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.

list's People

Contributors

leo avatar rauchg avatar greenkeeperio-bot avatar djalmaaraujo avatar mathiasbynens avatar dotcypress avatar

Watchers

James Cloos avatar Jeroen Engels avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.