Go CLI #

Go CLI 为团队的脚手架工具，终端命令为 g ，主要功能为：创建并初始化项目、克隆项目、拷贝代码、更新脚手架、卸载脚手架等。

安装脚手架 #

1. NPM 私有 scope 配置：

$ npm config set '@go:registry' 'http://rnpm.hz.netease.com'

2. 配置 SSH，并添加 至此 ：

$ ssh-keygen -t rsa -C "邮箱前缀"
$ cat ~/.ssh/id_rsa.pub

3. 安装脚手架：

$ npm init @go/cli

以上安装方式，会对安装环境、Git 配置、SSH 配置进行检查后安装，如需跳过检查直接安装，使用以下命令：

$ npm install @go/create-cli -g

4. 安装成功？查看 Go 提供的 所有功能 ，或者开始 创建一个新项目 。
5. 安装失败？查看安装遇到的问题 。

查看功能 #

在终端输入以下命令，查看 Go CLI 提供的所有功能：

$ g --help

输出如下：

Go CLI 命令行工具

Options:
  -V, --version                      输出 CLI 的版本号
  -h, --help                         查看支持的所有命令

Commands:
  create|c [options] <project-name>  创建新项目，项目命名规范：时间_客户名称，如：20220520_haier
  copy [options] <ssh-url>           拷贝仓库内容至当前目录
  clone <project-name>               克隆已创建的项目到本地
  update                             更新或者重新安装 CLI
  uninstall                          卸载 GO CLI
  help [command]                     输出 CLI 的版本号

创建新项目 #

切换至要创建的文件夹，创建并初始化项目：

$ g create <project-name>

也可以使用简写命令：

$ g c <project-name>

模板类型 #

在 CLI Template 中，可以查看各个模板的区别，以及提供的全部功能。

使用其它方式创建项目 #

使用 SSH 创建项目：

$ g create ssh://git@g.hz.netease.com:22222/sale_go/20220601_netease.git

使用 HTTPS 创建项目：

$ g create ssh://git@g.hz.netease.com:22222/sale_go/20220601_netease.git

使用项目链接（测试链接、正式链接）创建项目：

$ g create https://go.163.com/f2e/20220601_netease/index.html

包管理器 #

1. 安装项目时，提供了 npm 与 pnpm 两种包管理器。

2. 推荐使用 pnpm ，pnpm 可以复用使用不同项目的相同依赖，减少电脑内存占用，安装速度也更快，尤其是在家庭网络情况不稳定时优势更大。

3. pnpm 在 CLI 中，仅体现在依赖安装环节，clone 项目时，会自动判断设备是否安装 pnpm ，默认使用 pnpm 安装，如判断设备未安装 pnpm 则使用 npm 安装克隆项目的依赖。

4. 除了项目安装环节，其它环节都使用 npm 命令，如果需要将常用的包加入 pnpm 缓存，可以使用 pnpm add 代替 npm install。

创建私有项目 #

如需本地创建私有项目，不上传 Gitlab，比如本地 Demo 测试等，可以使用以下命令：

$ g create <project-name> -p

拷贝仓库代码至当前文件夹 #

如需拷贝一个 Gitlab 仓库的 全部/部分 代码至当前文件夹，可以使用该命令，该命令同样适用于 Gitlab 代码片段 的拷贝，通过该命令，可以避免仓库 .git 文件拷贝到当前文件下。

拷贝整个仓库内容至当前目录：

$ g copy <ssh-url>

拷贝仓库指定文件夹、文件至当前目录：

$ g copy <ssh-url> --dir src

拷贝文件夹，同时更新依赖：

$ g copy <ssh-url> -i

新建页面 #

Vite 已经提供了创建 多页面应用模式 的方式，因此 Go CLI 将不再重复提供该功能。

更新专题 #

项目创建过程，会自动将输入的页面信息更新至 专题列表，如需调整专题信息，请自行拉取 仓库 进行调整。

安装遇到的问题 #

Windows cmd 不支持 cat 命令 #

由于 Windows 部分系统 cmd （命令提示符）不支持 cat 命令，微软官方建议使用 PowerShell 作为日常终端使用，也建议 Windows 用户均使用 PowerShell 来使用 Go CLI 的命令.

如果 Windows 设备默认安装了 PowerShell ，VS Code 内置终端默认开启的就是 PowerShell 。

Node.js 版本问题 #

Go CLI 支持 Node.js >= 14.0.0 的版本，如果您的版本低于 14.0.0 ，建议 升级 Node.js 后重新尝试。

查看 Node.js 版本：

$ node --version

PowerShell 执行策略问题 #

公司电脑的 PowerShell 安装后运行 go 提示没有该命令，按照 命令行提示 ，使用管理员权限运行 PowerShell 更改执行策略即可：

$ Set-ExecutionPolicy -ExecutionPolicy RemoteSigned

SSH 配置失败的问题 #

如果使用 Go CLI 提示无法检测 SSH 是否安装成功，需 手动配置 SSH ，如果已经手动配置过 SSH ，则忽略该警告。

外网拉取项目失败 #

公司外部的网络拉取或者创建项目，需要 申请 VPN 来使用。

使用 git bash 更新失败 #

Windows 使用 git bash 运行 go update 命令，会出现权限错误，需手动删除 C:\Users\username\AppData\Roaming\npm\ 文件夹下的 create-cli 与 go 相关的文件，再使用其他终端重新安装。

更新日志 #

• CHANGELOG