当前位置：首页 > news >正文

前端自动化部署之ssh2和ssh2-sftp-client

news 2025/7/8 10:13:21

ssh2-sftp-client 本身是一个专门用于处理 SFTP文件操作的库，它不直接提供执行远程命令的功能。但是可以通过它的底层依赖库 ssh2 实现执行命令的功能。

以下是实现方法和示例代码：

方法一：使用 `ssh2` 执行远程命令

ssh2 是 ssh2-sftp-client 的底层库，它支持执行远程命令。

安装依赖

如果尚未安装 ssh2，可以通过以下命令安装：

npm install ssh2

代码示例

const { Client } = require('ssh2');const serverOptions = {host: 'your-server-ip',port: 22,username: 'your-username',password: 'your-password', // 或者使用 privateKey
};const command = 'ls -l /home/cuijiying/log_tools';const conn = new Client();conn.on('ready', () => {console.log('SSH 连接成功！');conn.exec(command, (err, stream) => {if (err) throw err;stream.on('close', (code, signal) => {console.log(`命令执行完成，退出代码：${code}`);conn.end();}).on('data', (data) => {console.log('输出：\n' + data.toString());}).stderr.on('data', (data) => {console.error('错误：\n' + data.toString());});});
}).connect(serverOptions);

输出解释

标准输出通过 stream.on('data') 接收。
错误输出通过 stream.stderr.on('data') 接收。

方法二：结合 `ssh2-sftp-client` 和 `ssh2`

如果你同时需要执行命令和进行 SFTP 文件操作，可以同时使用 ssh2 和 ssh2-sftp-client。

代码示例

const { Client } = require('ssh2');
const SftpClient = require('ssh2-sftp-client');const serverOptions = {host: 'your-server-ip',port: 22,username: 'your-username',password: 'your-password',
};const command = 'df -h'; // 示例命令：查看磁盘使用情况
const sftp = new SftpClient();
const conn = new Client();async function executeCommand() {return new Promise((resolve, reject) => {conn.on('ready', () => {console.log('SSH 连接成功！');conn.exec(command, (err, stream) => {if (err) return reject(err);let output = '';stream.on('close', (code, signal) => {console.log(`命令执行完成，退出代码：${code}`);conn.end();resolve(output);}).on('data', (data) => {output += data.toString();}).stderr.on('data', (data) => {console.error('错误：\n' + data.toString());});});}).connect(serverOptions);});
}async function main() {try {// 执行远程命令const commandOutput = await executeCommand();console.log('命令输出：\n', commandOutput);// 使用 SFTP 上传文件await sftp.connect(serverOptions);await sftp.put('./example.zip', '/home/cuijiying/example.zip');console.log('文件上传成功！');} catch (err) {console.error('操作失败：', err);} finally {sftp.end();}
}main();

方法三：使用 `ssh2` 的高级特性（Shell 模式）

如果需要执行多个命令，可以使用 Shell 模式。

代码示例

const { Client } = require('ssh2');const serverOptions = {host: 'your-server-ip',port: 22,username: 'your-username',password: 'your-password',
};const conn = new Client();conn.on('ready', () => {console.log('SSH 连接成功！');conn.shell((err, stream) => {if (err) throw err;stream.on('close', () => {console.log('Shell 会话结束');conn.end();}).on('data', (data) => {console.log('输出：\n' + data.toString());});// 执行多个命令stream.write('pwd\n');stream.write('ls -l\n');stream.write('exit\n');});
}).connect(serverOptions);