@wind-js/cli.wind.js

CLI for creating new wind.js backed projects

Usage no npm install needed!

<script type="module">
  import windJsCliWindJs from 'https://cdn.skypack.dev/@wind-js/cli.wind.js';
</script>

README

logomakr_8cwvt1">

npm Build Status Coverage Status PRs Welcome issues Welcome npm GitHub issues GitHub pull requests Downloads

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

Installation

gt; npm i @wind-js/cli.wind.js -g

Usage

  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:

gt; cli.wind.js --help

Examples

How to check the list of available standard prototypes:

gt; cli.wind.js list
[info] There are 2 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] You can create a new project based on this prototype with the following command:
[info] cli.wind.js new my-project-name ui.poc
[info] Prototype ui < https://github.com/CodeInBrackets/bootstrap.ui.wind.js/ >
[info] Prototype based on a ui.wind.js. It implements a basic counter 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/bootstrap.ui.wind.js/releases/download/v1.0.0/bootstrap-ui-wind.js.zip
[info] You can create a new project based on this prototype with the following command:
[info] cli.wind.js new my-project-name ui

How to create a new project from a standard template:

gt; cli.wind.js new my-project ui
[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
[info] We are going to download the following prototype:
[info] Prototype URL: https://github.com/CodeInBrackets/bootstrap.ui.wind.js/releases/download/v1.0.0/bootstrap-ui-wind.js.zip
[info] Prototype MD5 URL: https://github.com/CodeInBrackets/bootstrap.ui.wind.js/releases/download/v1.0.0/bootstrap-ui-wind.js.zip.md5
[info] Downloading and verifying... it may take a while.
[fine] Prototype downloaded succesfully at my-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:

gt; 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 pixel_perfect from Flaticon is licensed under CC BY 3.0. Check out the new logo that I created on LogoMakr.com https://logomakr.com/8CWVt1