scafford-cli v0.0.1

scrafford-cli

a scaffolding help you to clone repo and download template

install

$ npm install -g  scrafford-cli 

Usage

condition

had Configured the SSH about github/gitlab.

commands

scafford : a parent command , to show help, veriosn and so on
scafford-init : a sub command , to create project 
scafford-list : a sub command , to show tempalte list

> show help:
    $ scafford 
    # or 
    $ scafford --help
    
> show version:
    $ scafford -V
    # or 
    $ scafford --version
    
> show scafford-init help
    $ scafford init --help
    
> show offical template list:
    $ scafford list
    
> create project:
    $ scafford init [template-name] [template-enterprise-name] [repo-name]
              [repo-enterprise-name] [output-directory][isOffline]
    
    # create a new app project with an official template
    $ scafford init -o my-project

    # create a new project straight from a gitlab/github template
    $ scafford init -t username_template/repo_template -o my-project

    # clone a repo from gitlab/github  and copy an official template
    $ scafford init -o my-project -c [gitlab|github]:username/repo -e "cvte"

    # clone a repo from gitlab/github and copy an unofficial template
    $ scafford init -o my-project -c [gitlab|github]:username/repo 
              -t [gitlab|github]:username_template/repo_template

    # clone a repo from gitlab/github and copy template from local template cscaffordhe
    $ ac init -o my-project -c [gitlab|github]:username/repo -e "cvte" --offline

details

> template-name : which template you choose to download , default "chrome-app-cli". 
  if you use an unoffical template,such as "yuchaozhong/test-tempalte",app-cli will 
  find the repo in personal gitlab/github/bitbucket account
  
> template-enterprise-name : where enterprise account is tempalte in , default "cvte", 
  for the "gitlab.gz.cvte.cn".if you use an unoffical template and the template is in 
  the personal account , set it "";
  
> repo-name : which repo you want to clone , you should tell which platform the repo 
  exists in, such as 'gitlab:yuchaozhong/test-app'
  
> repo-enterprise-name : where enterprise account is repo in. if you don not set it, 
  app-cli will find the repo in personal gitlab/github/bitbucket account
  
> output-dirtionary : the output directory, default "."(current dir), which should be a 
  nonexistent or empty directory.
  
> isOffline : you can use local cached templcate by add the option --offline