dwqs / chare

A simple CLI scaffolding for front-end projects

README: 中文

chare

A simple CLI scaffolding for front-end projects.

Installation

Prerequisites: Node.js (>=6.x) and Git.

$ npm install chare -g

Usage

$ chare init <template-name> <project-name>

You can also relate a remote repo:

chare init <template-name> <project-name> -o remote-repo-url

Example:

$ chare init dwqs/vue-startup my-project

$ chare init waka-templates/vue-webpack2 my-project

Relate a remote repo:

$ chare init vuejs-templates/webpack-simple my-project -o [e-mail]:xxx/xxx.git

The above command pulls the template from here or writing custom templates, prompts for some information, and generates the project at ./my-project/.

Command

• chare or chare -h --- find help info for chare.
• chare init template-name your-project-name [-o remote-origin] --- init your project with specified template.
• chare token -u your-github-user-name -p your-personal-token --- set auth token to get a higher rate limit of api requests. Check out the documentation for more details.

Note: Check out the documentation for more details about Basic Authentication.

Templates from github

It's unlikely to make everyone happy with the official templates. You can simply fork an official template and then use it via chare-cli with:

chare init username/repo my-project

Where username/repo is the GitHub repo shorthand for your fork. But the repo need to meet some conditions. See this: here or writing custom templates

Local Templates

Instead of a GitHub repo, you can also use a template on your local file system:

chare init ~/fs/path/to-custom-template my-project

There is a guide or writing custom templates for to writing owner customized template.

Thanks

To metalsmith scaffolder && vue-cli for the head start.