在前端开发中，我们常常需要与远程服务器交互，比如从服务器上下载或上传文件。此时，ssh-promise 这个 npm 包就能派上大用场。
ssh-promise 是一个封装了 ssh2 的库，通过该库我们可以在 Node.js 中方便地使用 ssh 协议进行远程操作。接下来，我将带大家学习 ssh-promise 的使用方法。
安装
使用 ssh-promise 首先需要安装它。我们可以运行以下命令：
npm i ssh-promise
安装完成后，我们就可以在项目中使用 ssh-promise 了。
连接远程服务器
在使用 ssh-promise 之前，我们需要先创建一个 ssh 连接。创建连接的代码如下：
const ssh = require('ssh-promise');
const conn = new ssh({
host: '服务器地址',
port: 22,
username: '用户名',
privateKey: '私钥文件的路径'
});其中，host、port、username 和 privateKey（私钥文件的路径）是必填的配置项。私钥文件可以是绝对路径，也可以是相对路径。
连接创建成功后，我们就可以使用该连接来执行远程操作了。
执行远程命令
ssh-promise 提供了多种方法来执行远程命令。以 execute 方法为例，我们可以使用以下代码来执行一个 ls 命令：
conn.execute('ls')
.then(result => console.log(result))
.catch(err => console.error(err));其中，execute 方法返回的是一个 Promise，在 Promise 中会返回执行结果。如果执行出错，可以使用 catch 来捕获错误。
上传和下载文件
ssh-promise 提供了 upload 和 download 方法，用于上传和下载文件。以 upload 方法为例，我们可以使用以下代码来上传一个文件：
-- -------------------- ---- ------- ----- -- - -------------- ----- --------- - --------- ----- ---------- - --------- ------------- ------ ------------------------------- ------- ---------- ---------- -- - -------------------- ------------ -- - ------------------ ---
upload 方法接收一个对象，其中 local 表示本地文件，remote 表示远程文件。我们需要使用 fs 模块读取本地文件，然后将其传给 local。
download 方法跟 upload 方法类似，只不过它是将远程文件下载到本地。
总结
通过以上代码，我们可以看出 ssh-promise 提供了很方便的方法来操作远程服务器。您可以根据项目需求来灵活使用它提供的方法，以提高项目的效率。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600670a78ccae46eb111f282