# hcli

**Repository Path**: wang_duan/hc

## Basic Information

- **Project Name**: hcli
- **Description**: 研究构建一个脚手架工具
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-09-28
- **Last Updated**: 2023-07-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

#### 开发安装

1. 获取本项目 `git clone xxx`

2. 推荐使用 `pnpm i` 当然也可以使用 `yarn` 或者 `npm i`

3. 进入项目执行 `npm link`

4. 然后你就可以全局使用我们的工具试试 `hcgo -h`

#### 使用安装

如果你只想简单的使用，你只需要 `npm i git+https://gitee.com/wang_duan/hc.git -g` 即可全局使用 `hcgo -h`

公司项目放入 npm 里面没有什么意义，大家直接使用 git 仓库即可。同时你又get到了一个知识点，原来 npm 还可以直接安装git仓库的包！

### 使用说明

```TypeScript
Usage: index [options] [command]

本项目适用于海鹚区域项目,可通过一个cli运行所有海鹚区域的项目。

Options:  
-v,--version    查看当前cli版本  
-h,--help       显示帮助信息  

Commands:  
build [options] 打包运行项目，通过 -env 指定环境
watch [options] 监听运行项目，通过 -env 指定环境
publish [options]  publish 发布项目禁止指定环境
help [command]  你可以尝试一下 hcgo help build
```


每个命令都可以查看帮助信息，你可以在终端输入 `hcgo help build` 查看示例

#### 参数解释

|子命令|说明|备注|
|-|-|-|
|watch|监听运行测试环境微信小程序|一般用于开发时使用|
|build|执行正正式境微信小程序打包|一般用于提测时使用（[需要配置 key](https://developers.weixin.qq.com/miniprogram/dev/devtools/ci.html)）|
|publish|发布到微信小程序体验版|一般用于发布时使用（开发中）|

开发（watch）

|说明|命令|备注|
|-|-|-|
|运行测试环境|`hcgo watch --dir=p099`|默认测试环境首页|
|运行正式环境|`hcgo watch --dir=p099 --env=prod`|--env指定环境 --dir指定项目|

提测（build）

|说明|命令|备注|
|-|-|-|
|发布体验版|`hcgo build --dir=p099`|默认测试环境首页|
|生成二维码|`hcgo build --env=prod --path=pages\home\idnex --dir=p099`|--env指定环境 --path指定路径 --dir指定项目|

发布（publish）

|说明|命令|备注|
|-|-|-|
|发布|`hcgo publish --dir=p099`|默认发布到正式环境|