teng2015 / scion

A simple CLI for creating your projects

SCION

A light CLI to generate projects in an easy way.

Installation

npm install scion-cli -g

or

git clone https://github.com/jrainlau/scion.git

cd scion && npm install

npm link

Usage

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

  Usage: scion <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

Commands

add | a

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

$ scion add

 /*  your template's name */
Template name: my-tpl

 /* your template's git https link, note that it ends with .git */
Git https link:  https://gitxxx/somebody/my-tpl.git 

 /* your template's branch */
Branch: master 

Once confirm you'll see the message like below:

The last template list is:

{ tpl:
   { 'my-tpl-name':
      { url: 'https://gitxxx/somebody/my-tpl.git',
        branch: 'master' } } }

Now you've added a new template to Scion successfully.

list | l

It shows you the templates list.

$ scion list

{ tpl:
   { 'my-tpl-name':
      { url: 'https://gitxxx/somebody/my-tpl.git',
        branch: 'master' } } }

init | i

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

$ scion init

/* enter a template name which was added by yourself */
Template name: my-tpl-name

/* your project name */
Project name: my-new-project

After enter correct template name and confirm, you'll see the message below:

Start generating...

 √ Generation completed!

 cd my-new-project && npm install

It's easy, right?

delete | d

To delete a template, you could use this command:

$ scion delete

and type the template name you want to delete:

Template name: my-tpl-name

if the name exist, you will see:

Template deleted!
The last template list is:

{ tpl:
   { 'my-tpl-name': undefined } }

once a template is undefined, it means you've deleted it successfully.

Template

The most important part of Scion 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 Scion's templates.json.

License

MIT.