A simple CLI scaffolding for front-end projects.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
lib
.editorconfig
.gitignore
CHANGELOG.md
LICENSE
README.md
README.zh-CN.md
commitlint.config.js
package-lock.json
package.json

README.md

English | 简体中文

iboy download npm-version license

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 git@github.com: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 or iboy -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.