q-cli

English

使用 远程模板项目 生成本地项目

使用方法

进入本项目根目录，执行 npm link，即可全局安装本脚手架。

在命令行输入 q-cli -h 即可查看所有的命令说明。

生成项目

q-cli 支持下载 子目录（或子文件），使用方法：

q-cli init <projectName> [subdir]

当选择的模板项目中包含所输入的子目录（或子文件）时，q-cli 将仅使用 子目录中的文件（或子文件）。如果模板项目中不包含所指定的子目录（或子文件），将使用整个项目模板。

注意指定使用模板中的某个子文件，需要保持 porjectName 格式与该子文件格式 一致，例如：q-cli init app.js server.js

添加模板

命令行键入 q-cli config --all，即可查看所有配置。请参照 q-cli config templates 的结构加入模板。

例如，假设 q-cli 的配置文件中暂无任何模板，同时我想添加 github 上的模板，过程如下：

q-cli config templates [] # config.tempaltes = []
q-cli config templates.0 {} # config.templates[0] = {}
q-cli config templates.0.rootURL justemit # config.templates[0].rootURL = "justemit"
q-cli config templates.0.templates [] # config.templates[0].templates = []
q-cli config templates.0.templates.0 vue-ssr-boilerplate # config.templates[0].templates[0] = "vue-ssr-boilerplate"

执行 q-cli list，命令行输出应为：

  1. justemit/vue-ssr-boilerplate

注意

如果使用私有 gitlab 的模板项目必须设置 clone: true，同时下载地址的形式应为：

git.yourdomain.com:group/projectname

例如：

{
  "rootURL": "your-gitlab-domain.com:your-gitlab-group",
  "templates": ["repo"],
  "options": {
    "clone": true
  }
}