lingon-cli/README.md

Command line interface to Lingon, a static site generator.

# lingon-cli

The command line interface to [lingon](http://github.com/jpettersson/lingon), a minimal static site generator inspired by Middleman and Sprockets.

# Installation

Install the lingon cli globally:

```bash
npm install -g lingon-cli
```

# Quickstart

```bash
# Initialize a new lingon project
lingon new my-project

# start the lingon server
cd my-project
lingon

# Output: 
# [ Lingon ] Working directory: /Path/to/project/my-project
# [ Lingon ] http server listening on: 0.0.0.0:5678
```

The app is now accessible on `0.0.0.0:5678`.

Read more about [lingon here](https://github.com/jpettersson/lingon).

# Usage

This package will add a `lingon` binary to your path. It functions as a proxy to the lingon.js file and supports the exact same arguments.

```bash
# Generate a lingon new lingon project:
lingon new my-project # will clone https://github.com/javoire/lingon-template-minimal
lingon new my-project -t angular # will clone https://github.com/jpettersson/lingon-ng-template

# Start the server: 
lingon

# Build once and quit:
lingon build

# Show version: 
lingon -v

# Show help: 
lingon -h

# Start the server on a custom port:
lingon server -p 1111
```