Xu-cli NPM | npm.io

XU-CLI

A light tool to generate projects in an easy way.

Installation

npm install xu-cli -g

git clone https://github.com/xuxiang32/xu-cli.git

cd xu-cli && npm install

npm link

Usage

Open your terminal and type xu or xu -h , you'll see the help infomation below:

  Usage: xu <command>


  Commands:

    add|a      Add a new template
    list|l     List all the templates
    init|i     Generate a new project
    delete|d   Delete a template

  Options:

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

Note that if you are using MacOS, sudo was required while using commands add and delete.

Commands

list | l

It shows you the templates list.

$ xu list

? By default, there are 3 sets of templates.
? If you do not like , you can use `xu add` command to add your's templates.

┌────────────────────┬──────────────────┬────────┐
│ Template Name      │ Owner/Name       │ Branch │
├────────────────────┼──────────────────┼────────┤
│ vue                │ xuxiang32/xu-cli │ master │
├────────────────────┼──────────────────┼────────┤
│ angular4           │ xuxiang32/xu-cli │ master │
├────────────────────┼──────────────────┼────────┤
│ react-redux        │ xuxiang32/xu-cli │ master │
└────────────────────┴──────────────────┴────────┘

init | i

After adding new templates, you could use this command to generate your own project by choosing template.

$ xu init

? Template name: vue
? Project name: vue-project
? Where to init the project? ../
⠹ Downloading template...

New project has been initialized successfully!

It's easy, right?

add | a

This command would help you to add a new template to the templates.json, which will be used by xu to generate projects.

$ xu add

? This command would help you to add your's template
? Set the custom name of the template: my-first-template
? Owner/name of the template: `yourself`
? Branch of the template: new
┌────────────────────┬──────────────────┬────────┐
│ Template Name      │ Owner/Name       │ Branch │
├────────────────────┼──────────────────┼────────┤
│ vue                │ xuxiang32/xu-cli │ master │
├────────────────────┼──────────────────┼────────┤
│ angular4           │ xuxiang32/xu-cli │ master │
├────────────────────┼──────────────────┼────────┤
│ react-redux        │ xuxiang32/xu-cli │ master │
├────────────────────┼──────────────────┼────────┤
│ my-first-template  │ `yourself`       │ master │
└────────────────────┴──────────────────┴────────┘
✔ New template has been added successfully!

xu-cli use download-git-repo to down load git repos. After answering 3 questions, you'll add a new template to Scion.

delete | d

To delete a template, you could use this command:

$ xu delete

? Which template you want to delete? my-first-template

┌────────────────────┬──────────────────┬────────┐
│ Template Name      │ Owner/Name       │ Branch │
├────────────────────┼──────────────────┼────────┤
│ vue                │ xuxiang32/xu-cli │ master │
├────────────────────┼──────────────────┼────────┤
│ angular4           │ xuxiang32/xu-cli │ master │
├────────────────────┼──────────────────┼────────┤
│ react-redux        │ xuxiang32/xu-cli │ master │
└────────────────────┴──────────────────┴────────┘
✔ Template has been deleted successfully

Template

The most important part of xu-cli is template. All templates' infomation were list in the templates.json. A template means a project sample, which has a simple or complex file structure.

You can create your own templates repository, and push your templates in different branches. All you need to do then is to add the templates into templates.json.