## m-ssh-deploy 地址：https://www.npmjs.com/package/m-ssh-deploy `m-ssh-deploy`是一個在沒有`jenkins`或者其他大型部署系統下推薦使用的一款自動部署工具。能夠簡化手動部署流程，實現自動化過程，**打包**、**壓縮**和**上傳到服務器**一鍵執行。 部署出錯、完成支持彈窗顯示。 [](https://camo.githubusercontent.com/d824018288e14bc5b38b79253b14fce2f9bb92a28931626f954aef7e5d0cef8c/68747470733a2f2f6d616a786d32312e67697465652e696f2f6d6a785f626c6f672f6173736574732f696d672f6465706c6f792e34356562346130382e676966) 源碼地址[https://gitee.com/MaJXm21/m-deplot-tsc](https://gitee.com/MaJXm21/m-deplot-tsc) ## [](https://www.npmjs.com/package/m-ssh-deploy#dome-%E6%A0%B7%E5%BC%8F-)??Dome 樣式?? 1.安裝 先設置為npm源`npm config set registry http://registry.npmjs.org/` `npm i m-ssh-deploy -D` 2.在項目任意位置創建一個**deploy.js**文件 ~~~js const deploy = require('m-ssh-deploy').default const deployConfig = { name: '某某項目名稱', // 部署名稱 // 選擇列表 choices: [ { name: '測試環境', value: 'development', }, { name: '測試環境(debug)', value: 'development:debug', }, ], // 配置列表 deployList: [ { VALUE: 'development', // 提供選擇，跟choices的value SERVER_PATH: '192.168.100.100', // ssh地址 服務器地址 SSH_USER: 'root', // ssh 用戶名 PASSWORD: 'root', // 用密碼連接服務器 PATH: '/home/app/dist', // 需要上傳的服務器目錄地址 如 /usr/local/nginx/html SCRIPT: 'npm run build:prod', ASSETS_PATH: 'dist', // 打包完后的目錄 SERVER_CMD: ['ls'], // 自定義在服務器上執行的指令，從左到右執行 RUN_MODEL: 3, // 1:只打包 2:打包和壓縮zip 3:打包、壓縮zip、上傳服務器 默認是3 }, { ... } ], } deploy(deployConfig) // 運行 ~~~ 3.在**package.json**的`scripts`增加一個`"deploy":"node ./deploy.js"` ~~~json { ..., "scripts": { ..., "deploy": "node ./deploy.js" } ... } ~~~ 4.運行 `npm run deploy` ## [](https://www.npmjs.com/package/m-ssh-deploy#-%E9%80%89%E6%8B%A9%E9%83%A8%E7%BD%B2)??選擇部署 實現`select`人性化配套，支持多環境 [](https://www.npmjs.com/package/m-ssh-deploy) ## [](https://www.npmjs.com/package/m-ssh-deploy#-%E5%8F%82%E6%95%B0%E8%A6%81%E6%B1%82-)??參數要求?? | 參數 | 說明 | 類型 | 可選擇 | 默認值 | 必傳 | | --- | --- | --- | --- | --- | --- | | name | 項目名稱 | string | — | — | ? | | choices | 交互式選擇列表，詳細看下面`choices` | array\[object\] | — | — | ? | | deployList | 配置列表，詳細下面`deployList` | array\[object\] | — | — | ? | > `choices`和`deployList`長度必須一致，才能匹配得上 ### [](https://www.npmjs.com/package/m-ssh-deploy#choices)choices | 參數 | 說明 | 類型 | 可選擇 | 默認值 | 必傳 | | --- | --- | --- | --- | --- | --- | | name | 選項名稱 | string | — | — | ? | | value | 選項的值 | string | — | — | ? | ### [](https://www.npmjs.com/package/m-ssh-deploy#deploylist)deployList | 參數 | 說明 | 類型 | 可選擇 | 默認值 | 必傳 | | --- | --- | --- | --- | --- | --- | | VALUE | 對應的是 choices\[\].value 的值 | string | — | — | ? | | SERVER\_PATH | 服務器地如址 192.168.1.1 | string | — | — | `RUN_MODEL`\=== 3 | | SSH\_USER | 服務器登錄用戶名 | string | — | — | 同上 | | PASSWORD | 服務器登錄密碼 | string | — | — | 同上 | | PATH | 需要上傳的服務器目錄地址 | string | — | — | 同上 | | SCRIPT | 打包執行的命令比如 npm run build | string | — | — | `RUN_MODEL`\=== 1 | | ASSETS\_PATH | 項目打包后的靜態資源目錄 | string | — | — | 同上 | | SERVER\_CMD | 自定義服務器指令，從左到右執行 | array\[string\] | — | — | — | | RUN\_MODEL | 選擇模式，1:只打包、2:打包壓縮、3:打包壓縮上傳、4:自定義服務器指令 | number | 1,2,3,4 | — | ? | ### [](https://www.npmjs.com/package/m-ssh-deploy#%E5%86%85%E7%BD%AE%E6%8C%87%E4%BB%A4)內置指令 | 指令名 | 說明 | | --- | --- | | builtIn:1 | 打包 | | builtIn:2 | 壓縮 | | builtIn:3 | 上傳 | | builtIn:5 | 連接服務器 | # [](https://www.npmjs.com/package/m-ssh-deploy#%E4%BD%BF%E7%94%A8%E6%96%B9%E5%BC%8F)使用方式 這種方式只能在傳模式(`RUN_MODEL`)為`4`的情況下使用，例如 * `SERVER_CMD: ['builtIn:1']`打包 * `SERVER_CMD: ['builtIn:1', 'builtIn:2']`打包和壓縮