iboy
v0.1.3
Published
A simple CLI scaffolding for front-end projects
Downloads
10
Maintainers
Readme
English | 简体中文
iboy
A simple CLI scaffolding for front-end projects.
Installation
Prerequisites: Node.js (>=6.x) and Git.
$ npm install iboy -g
Usage
$ iboy init <template-name> <project-name>
You can also relate a remote repo:
iboy init <template-name> <project-name> -o remote-repo-url
Example:
$ iboy init Zilean/m-vcli my-project
Relate a remote repo:
$ iboy init vuejs-templates/webpack-simple my-project -o [email protected]: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
iboy
oriboy -h
--- find help info for iboy.iboy init template-name your-project-name [-o remote-origin]
--- init your project with specified template.iboy 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 iboy-cli
with:
iboy 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:
iboy 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.