An open API service indexing awesome lists of open source software.

https://github.com/rumkin/helicopter-cli

Helicopter cli tool
https://github.com/rumkin/helicopter-cli

Last synced: about 1 year ago
JSON representation

Helicopter cli tool

Awesome Lists containing this project

README

          

Helicopter cli
---

Helicopter cli tool is a very simple util which load `helicopter.js` binary file
from current directory with lookup like node does and requires it. It search
installed `helicopter` inside node_modules folders.

It has no dependencies, extra lightweight and written in pure shell script.

## Install

```
npm install -g helicopter-cli
```

## Usage

Helicopter script pass all arguments to helicopter executable and redirect stdin.

```
helicopter [OPTIONS]
```

## Commands

Helicopter cli tool has two own commands `init` and `create` which helps to
build projects from template.

```
init [DIR]
create [DIR]
```

If command not exists in helicopter cli tool it will be searched in the nearest
installed `helicopter` package

### Init

Init command creates new project from basic helicopter template. It has one
optional parameter `DIR` which specifies directory of newly created project.

### Create

Create command download template from github or npm to specified directory or $PWD.

```shell
helicopter create helicopterjs/basic # Install template from github.com
helicopter create helicopter-basic # Install template from npm
```

## Example

Run server

```shell
helicopter up 8080
```