# deploy-cli

**Repository Path**: glony/deploy-cli

## Basic Information

- **Project Name**: deploy-cli
- **Description**: vue node 自动打包发布 cli 
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-11-16
- **Last Updated**: 2025-08-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# deploy-cli
前端轻量化部署脚手架，支持测试、线上等多环境部署，支持环境配置扩展，配置好后仅需一条命令即可完成整个部署流程。

## git地址：
  https://gitee.com/glony/deploy-cli.git

源代码fork: https://github.com/dadaiwei/fe-deploy-cli

**在原代码基础上添加服务器代码备份功能**

## 安装
项目安装引用：

```
// 直接clone 项目，使用link 全局引用 测试
npm link

// package.json 中引用gitee资源
  ....
  devDependencies{
    "deploy":"git+https://gitee.com/glony/deploy-cli.git"
  }
  npm install git+https://gitee.com/glony/deploy-cli.git -D
   or
  yarn add git+https://gitee.com/glony/deploy-cli.git -D
  ....

```

打包 使用pkg 
```
npm install  -g pkg 
pkg -t node14-linux-x64,node14-win-x64,node14-macos-x64 cli.js 
```

## 使用
### 1.初始化部署模板
```
deploy init
```

### 2.配置部署环境
部署配置文件位于deploy文件夹下的`deploy.config.js`,
一般包含`dev`（测试环境）和`prod`（线上环境）两个配置，再有多余的环境配置形式与之类似，只有一个环境的可以删除另一个多余的配置（比如只有`prod`线上环境，请删除`dev`测试环境配置）。

具体配置信息请参考配置文件注释：
```
module.exports = {
  privateKey: '', // 本地私钥地址，位置一般在C:/Users/xxx/.ssh/id_rsa，非必填，有私钥则配置
  passphrase: '', // 本地私钥密码，非必填，有私钥则配置
  projectName: 'hivue', // 项目名称
  dev: { // 测试环境
    name: '测试环境',
    script: "npm run build-dev", // 测试环境打包脚本
    host: '10.240.176.99', // 开发服务器地址
    port: 22, // ssh port，一般默认22
    username: 'root', // 登录服务器用户名
    password: '123456', // 登录服务器密码
    distPath: 'dist',  // 本地打包dist目录
    backupDir:'/backup/',//服务器代码备份目录
    webDir: '/var/www/html/dev/hivue',  // // 测试环境服务器地址
  },
  prod: {  // 线上环境
    name: '线上环境',
    script: "npm run build", // 线上环境打包脚本
    host: '10.240.176.99', // 开发服务器地址
    port: 22, // ssh port，一般默认22
    username: 'root', // 登录服务器用户名
    password: '123456', // 登录服务器密码
    distPath: 'dist',  // 本地打包dist目录
    backupDir:'/backup/',//服务器代码备份目录
    webDir: '/var/www/html/prod/hivue' // 线上环境web目录
  }
  // 再还有多余的环境按照这个格式写即可
}
```

### 3 部署命令
```
 // 配置好`deploy.config.js`，运行
 // 查看部署命令
  deploy --help
 // 部署,默认prod
 deploy run prod
 or
 deploy run dev


```
### 待改进
archiver 包替换 compressing 包压缩使用 tar.gz