# cli.wind.js

> CLI for creating new wind.js backed projects

Latest version **1.0.1** (published 2018-08-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install cli.wind.js
pnpm add cli.wind.js
yarn add cli.wind.js
bun add cli.wind.js
```

Provides the command `cli.wind.js`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2018-08-12 |
| First published | 2018-08-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 222.2 KB |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| Author | Kevin Mas Ruiz |
| Maintainers | kmruiz |
| Keywords | actors, async, wind.js, ui, front-end, framework, cli |

## Links

- npm: https://www.npmjs.com/package/cli.wind.js
- Repository: https://github.com/CodeInBrackets/cli.wind.js
- Homepage: https://github.com/CodeInBrackets/cli.wind.js#readme
- Issues: https://github.com/CodeInBrackets/cli.wind.js/issues
- npm.io page: https://npm.io/package/cli.wind.js

## Dependencies (9)

- [uuid](https://npm.io/package/uuid.md) ^3.3.2
- [unzip](https://npm.io/package/unzip.md) ^0.1.11
- [colors](https://npm.io/package/colors.md) ^1.3.1
- [request](https://npm.io/package/request.md) ^2.87.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^7.0.0
- [commander](https://npm.io/package/commander.md) ^2.16.0
- [handlebars](https://npm.io/package/handlebars.md) ^4.0.11
- [nodejs-md5](https://npm.io/package/nodejs-md5.md) ^1.1.0
- [request-promise-native](https://npm.io/package/request-promise-native.md) ^1.0.5

## Alternatives

- [@sveltejs/kit](https://npm.io/package/@sveltejs/kit.md) — 2.2M weekly downloads
- [@atlaskit/theme](https://npm.io/package/@atlaskit/theme.md) — 402.0K weekly downloads
- [@tangle-network/brand](https://npm.io/package/@tangle-network/brand.md) — 10.0K weekly downloads
- [seneca](https://npm.io/package/seneca.md) — 7.4K weekly downloads
- [@bsb/base](https://npm.io/package/@bsb/base.md) — 7.2K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2018-08-12
- 1.0.0 — 2018-08-05

## README

# ![logomakr_8cwvt1](https://user-images.githubusercontent.com/3071208/42311453-254a1474-803e-11e8-957a-5c1c8d157b31.png)
[![npm](https://img.shields.io/npm/v/cli.wind.js.svg)](https://www.npmjs.com/package/cli.wind.js)
[![Build Status](https://travis-ci.org/CodeInBrackets/cli.wind.js.svg?branch=master)](https://travis-ci.org/CodeInBrackets/cli.wind.js)
[![Coverage Status](https://coveralls.io/repos/github/CodeInBrackets/cli.wind.js/badge.svg?branch=master)](https://coveralls.io/github/CodeInBrackets/cli.wind.js?branch=master)
![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)
![issues Welcome](https://img.shields.io/badge/issues-welcome-brightgreen.svg)
![npm](https://img.shields.io/npm/l/cli.wind.js.svg)
![GitHub issues](https://img.shields.io/github/issues/codeinbrackets/cli.wind.js.svg)
![GitHub pull requests](https://img.shields.io/github/issues-pr/codeinbrackets/cli.wind.js.svg)
![Downloads](https://img.shields.io/npm/dw/cli.wind.js.svg)

Command Line Interface for bootstrapping new projects with wind.js.

Installation
------------

```sh
$> npm i cli.wind.js -g
```

Usage
-----

```sh
  Usage: cli.wind.js [options] [command]

  Options:

    -v, --version                             output the version number
    -h, --help                                output usage information

  Commands:

    new [options] <project-name> [prototype]
    list [options]

```

You can check the usage of your current cli.wind.js version with the following command:

```sh
$> cli.wind.js --help
```

Examples
--------

How to check the list of available standard prototypes:

```sh
$> cli.wind.js list
[info] There are 1 standard prototypes.
[info] Prototype ui.poc < https://github.com/CodeInBrackets/ui.wind.js-poc-todolist/ >
[info] Prototype based on a ui.wind.js proof of concept. It implements a basic todo-list application with support for SASS, ES6 and asynchronous actors. Basic build and development environment with webpack, jest and testkit.wind.js.
[info]      URL https://github.com/CodeInBrackets/ui.wind.js-poc-todolist/releases/download/v1.0.0/ui.wind.js-poc-todolist-master.zip
[info]      MD5 https://github.com/CodeInBrackets/ui.wind.js-poc-todolist/releases/download/v1.0.0/ui.wind.js-poc-todolist-master.zip.md5
[info] You can create a new project based on this prototype with the following command:
[info] cli.wind.js new my-project-name ui.poc
```

How to create a new project from a standard template:

```sh
$> cli.wind.js new example-project ui.poc
[info] Creating directory ./__tmp for storing local downloads.
[fine] We will clean up everything when the project is ready.
[info] Resolving prototype with the following information:
[info] Prototype Name: ui.poc
[info] We are going to download the following prototype:
[info] Prototype URL: https://github.com/CodeInBrackets/ui.wind.js-poc-todolist/releases/download/v1.0.0/ui.wind.js-poc-todolist-master.zip
[info] Prototype MD5 URL: https://github.com/CodeInBrackets/ui.wind.js-poc-todolist/releases/download/v1.0.0/ui.wind.js-poc-todolist-master.zip.md5
[info] Downloading and verifying... it may take a while.
[fine] Prototype downloaded succesfully at example-project/
[info] Now we will generate the project from the template, this will take some time.
[fine] Ready to go!
[info] Remember that you have other resources and documentation:
[info] ui.wind.js: https://github.com/CodeInBrackets/ui.wind.js
[info] wind.js: https://github.com/CodeInBrackets/wind.js
[info] testkit.wind.js: https://github.com/CodeInBrackets/testkit.wind.js
[fine] Happy hacking!
```

How to create a project from custom zip and md5 file:

```sh
$> cli.wind.js new example-project --prototype-url=https://github.com/CodeInBrackets/ui.wind.js-poc-todolist/releases/download/v1.0.0/ui.wind.js-poc-todolist-master.zip --md5-url=https://github.com/CodeInBrackets/ui.wind.js-poc-todolist/releases/download/v1.0.0/ui.wind.js-poc-todolist-master.zip.md5
   
[info] Creating directory ./__tmp for storing local downloads.
[fine] We will clean up everything when the project is ready.
[info] Resolving prototype with the following information:
[info] Prototype URL: https://github.com/CodeInBrackets/ui.wind.js-poc-todolist/releases/download/v1.0.0/ui.wind.js-poc-todolist-master.zip
[info] Prototype MD5 URL: https://github.com/CodeInBrackets/ui.wind.js-poc-todolist/releases/download/v1.0.0/ui.wind.js-poc-todolist-master.zip.md5
[info] We are going to download the following prototype:
[info] Prototype URL: https://github.com/CodeInBrackets/ui.wind.js-poc-todolist/releases/download/v1.0.0/ui.wind.js-poc-todolist-master.zip
[info] Prototype MD5 URL: https://github.com/CodeInBrackets/ui.wind.js-poc-todolist/releases/download/v1.0.0/ui.wind.js-poc-todolist-master.zip.md5
[info] Downloading and verifying... it may take a while.
[fine] Prototype downloaded succesfully at example-project/
[info] Now we will generate the project from the template, this will take some time.
[fine] Ready to go!
[info] Remember that you have other resources and documentation:
[info] ui.wind.js: https://github.com/CodeInBrackets/ui.wind.js
[info] wind.js: https://github.com/CodeInBrackets/wind.js
[info] testkit.wind.js: https://github.com/CodeInBrackets/testkit.wind.js
[fine] Happy hacking!
```

### Logo
Player graphic by <a href="http://www.flaticon.com/authors/pixel-perfect">pixel_perfect</a> from <a href="http://www.flaticon.com/">Flaticon</a> is licensed under <a href="http://creativecommons.org/licenses/by/3.0/" title="Creative Commons BY 3.0">CC BY 3.0</a>. Check out the new logo that I created on <a href="http://logomakr.com" title="Logo Makr">LogoMakr.com</a> https://logomakr.com/8CWVt1

---
_Source: https://npm.io/package/cli.wind.js · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
