# w6s-cli

@w6s/cli是团队内部指定使用的 cli 工具，除了用于快速创建项目初始架构，还包含一些常用的功能，例如启动静态文件服务、设置配置等。

# 安装

环境要求：

Node.js 版本 >=10
Yarn (opens new window) (推荐使用) / npm

使用 Yarn 的理由：性能更好，使用更方便

通过以下命令进行安装：

yarn global add @w6s/cli
# or
npm install -g @w6s/cli

安装成功后，在 shell 中键入w6s，即可看到相关功能说明，如下：

Usage: w6s <command> [options]

Options:
  -V, --version    output the version number
  -h, --help       display help for command

Commands:
  init <app-name>  create a new project
  serve            http-server like, start a local static server
  deploy           automatically publish front-end resources
  set-mirror       set NPM or Yarn mirrors to Taobao sources, such as electron, node-sass
  qrcode           draw QRcode in terminal window
  env              print debugging information about your environment
  help [command]   display help for command

# 项目创建

通过w6s init命令，可快速创建内置项目架构，包括轻应用的移动端H5轻应用项目及通用的管理后台管理后台项目：

? 请选择项目类型  (Use arrow keys)
❯ 管理后台项目 
  移动端H5轻应用项目

项目模版的详细说明，请查看项目创建栏目。

# 文件静态服务

用于启动一个静态文件服务，常用于应用打包后的本地调试。

该功能是集成了serve (opens new window)模块，详细使用方法，可通过输入w6s serve --help进行查看。

# 资源发布

w6s-cli 集成了@w6s/cli-deploy的功能，详细说明文档，请查看cli-deploy。

# 设置源

通过使用w6s set-mirror命令，可以对Yarn和NPM包管理器设置 mirror，如下：

? 请选择包管理器 Yarn
? 请选择需要设置源的工具或库 (Press <space> to select, <a> to toggle all, <i> to invert selection)
❯◉ taobao-mirror
 ◉ node-sass
 ◯ node-gyp
 ◯ electron
 ◯ puppeteer
 ◯ chromedriver
 ◯ operadriver
 ◯ phantomjs
 ◯ selenium
 ◯ node-inspector

可以重复设置，若需要删除，请自行在相关配置文件编辑处理。

# 生成二维码

用于生成二维码，例如一个应用的访问地址，通过输入ws6 qrcode <app-url>，即可在 shell 上生成二维码，方便手机扫码调试。

详细使用方法，可通过输入w6s qrcode --help进行查看。

# 显示环境配置

输出当前设备的一些软件或工具的版本信息，例如：

Environment Info:

System:
  OS: macOS 10.15.4
  CPU: (4) x64 Intel(R) Core(TM) i5-5257U CPU @ 2.70GHz
Binaries:
  Node: 10.16.0 - ~/.nvm/versions/node/v10.16.0/bin/node
  Yarn: 1.22.4 - ~/.nvm/versions/node/v10.16.0/bin/yarn
  npm: 6.9.0 - ~/.nvm/versions/node/v10.16.0/bin/npm
Browsers:
  Chrome: 85.0.4183.102
  Edge: Not Found
  Firefox: 57.0
  Safari: 13.1

cli-deploy →