Node.js SSH 库 `node-ssh` 教程

1. 项目介绍

node-ssh 是一个用于在 Node.js 中实现 SSH2 协议的库，提供了 Promise 化的接口，方便开发者进行远程 shell 命令执行、文件传输等操作。这个库基于 ssh2，并且在它的基础上提供了更简洁的API。

主要特性

• 支持 SSH 密码、密钥登录
• 执行远程命令
• 文件和目录的上传与下载
• 支持 SFTP

2. 项目快速启动

首先，确保已经安装了 Node.js 和 npm。然后，你可以通过以下步骤来安装和使用 node-ssh：

安装

npm install node-ssh

使用示例

下面是一个简单的用法，展示如何连接到远程服务器并运行一个命令：

const { NodeSSH } = require('node-ssh');

const ssh = new NodeSSH();

async function runCommand() {
  try {
    // 连接到远程服务器
    const result = await ssh.connect({
      host: 'your_host',
      username: 'your_username',
      password: 'your_password', // 或者使用认证密钥
    });

    // 执行远程命令
    const cmdResult = await ssh.execCommand('ls -l');
    console.log(`命令输出:\n${cmdResult.stdout}`);

    // 关闭连接
    ssh.disconnect();
  } catch (error) {
    console.error('Error:', error);
  }
}

runCommand();

3. 应用案例和最佳实践

示例一：文件上传

ssh.putFile('/local/path/to/file.txt', '/remote/path/to/file.txt')
  .then(() => console.log('文件上传成功'))
  .catch(err => console.error('文件上传失败', err));

示例二：使用认证密钥登录

ssh.connect({
  host: 'your_host',
  username: 'your_username',
  identityFile: '/path/to/authentication/key'
});

最佳实践

• 总是在尝试连接服务器前检查配置信息的正确性。
• 使用非交互式登录方式以避免手动确认。
• 完成任务后记得断开连接以释放资源。

4. 典型生态项目

除了 node-ssh 本身，还有其他相关的生态系统项目可以与之配合使用：

• ssh2: node-ssh 基于的基础库，提供了底层的 SSH2 功能。
• cloudbase-cli: 腾讯云开发的 CLI 工具，其中使用了 node-ssh 进行部署操作。
• jsDAV: 一个 WebDAV 协议的 JavaScript 实现，包含了使用 node-ssh 的 SFTP 后端。

这些项目共同构建了一个强大的工具链，帮助开发者处理 SSH 和远程服务器相关的任务。