JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 49095
  • Score
    100M100P100Q147016F
  • License MIT

A lightweight CLI program to serve static sites~!

Package Exports

  • sirv-cli

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 (sirv-cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

sirv-cli

sirv-cli

A lightweight CLI program to serve static sites~!

Quickly start a server to preview the assets of any directory!

Just like serve, you may install and use sirv-cli globally or on a per-project basis.

Install

$ npm install --save sirv-cli

Note: This module can also be installed and used globally~!

Usage

Running sirv as a standalone command is an alias of sirv start, with the sole exception of displaying help text!

Note: This is because sirv-cli may include new commands in the future.
For example, compression may be extracted to a compress command, or watch may be added.

$ sirv --help

  Usage
    $ sirv <command> [options]

  Available Commands
    start    Start a static file server.

  For more info, run any command with the `--help` flag
    $ sirv start --help

  Options
    -v, --version    Displays current version
    -h, --help       Displays this message

  Examples
    $ sirv build --cors --port 8080
    $ sirv start build --cors --port 8080
    $ sirv public --quiet --etag --maxage 31536000 --immutable
    $ sirv public --http2 --key priv.pem --cert cert.pem
    $ sirv start public -qeim 31536000
    $ sirv start public --assets /static/
    $ sirv --port 8080 --etag
    $ sirv my-app --dev
$ sirv start --help

  Description
    Start a static file server.

  Usage
    $ sirv start [dir] [options]

  Options
    -D, --dev          Enable "dev" mode
    -e, --etag         Enable "ETag" header
    -d, --dotfiles     Enable dotfile asset requests
    -c, --cors         Enable "CORS" headers to allow any origin requestor
    -m, --maxage       Enable "Cache-Control" header & define its "max-age" value (sec)
    -i, --immutable    Enable the "immutable" directive for "Cache-Control" header
    -H, --http2        Enable the HTTP/2 protocol. Requires Node.js 8.4.0+
    -C, --cert         Path to certificate file for HTTP/2 server
    -K, --key          Path to certificate key for HTTP/2 server
    -s, --single       Serve single-page applications
    -a, --assets       Prefix for the asset files of single-page applications
    -q, --quiet        Disable logging to terminal
    -H, --host         Hostname to bind  (default localhost)
    -p, --port         Port to bind  (default 5000)
    -h, --help         Displays this message

Note: The HOST and PORT environment variables will override flag values.

HTTP/2

Running a HTTP/2 server is available to users running Node.js v8.4.0 or later.
However, since no browsers support unencrypted HTTP/2, you must provide --key and --cert options to sirv-cli. These are read and passed to http2.createSecureServer, which is necessary for browser clients to connect.

You can generate a certificate and key for local development quickly with:

$ openssl req -x509 -newkey rsa:2048 -nodes -sha256 -subj '/CN=localhost' \
  -keyout localhost-privkey.pem -out localhost-cert.pem

License

MIT © Luke Edwards