ssh2-sftp-client

import SftpClient from 'ssh2-sftp-client'; import path from 'path'; import fs from 'fs/promises'; async function sftpExample() { const sftp = new SftpClient(); const host = process.env.SFTP_HOST ?? 'sftp.example.com'; const port = parseInt(process.env.SFTP_PORT ?? '22', 10); const username = process.env.SFTP_USERNAME ?? 'user'; const password = process.env.SFTP_PASSWORD ?? 'password'; // Or use privateKey: fs.readFileSync('~/.ssh/id_rsa') const remoteDir = '/home/user/uploads'; const remoteFile = path.join(remoteDir, 'test_upload.txt'); const localFileToUpload = 'local_file.txt'; const localFileToDownload = 'downloaded_file.txt'; try { console.log(`Attempting to connect to ${username}@${host}:${port}...`); await sftp.connect({ host, port, username, password }); console.log('Successfully connected to SFTP server.'); // Ensure the remote directory exists await sftp.mkdir(remoteDir, true); // Create a dummy local file for upload await fs.writeFile(localFileToUpload, 'Hello from Node.js SFTP client!'); console.log(`Uploading ${localFileToUpload} to ${remoteFile}...`); await sftp.put(localFileToUpload, remoteFile); console.log('File uploaded successfully.'); // List contents of the remote directory console.log(`Listing contents of ${remoteDir}:`); const list = await sftp.list(remoteDir); list.forEach(item => console.log(` - ${item.name} (${item.type})`)); // Download the uploaded file console.log(`Downloading ${remoteFile} to ${localFileToDownload}...`); await sftp.get(remoteFile, localFileToDownload); console.log('File downloaded successfully.'); // Verify downloaded content (optional) const downloadedContent = await fs.readFile(localFileToDownload, 'utf8'); console.log('Downloaded content:', downloadedContent); // Delete the remote file console.log(`Deleting remote file ${remoteFile}...`); await sftp.delete(remoteFile); console.log('Remote file deleted.'); } catch (err) { console.error('SFTP operation failed:', err.message); } finally { if (sftp.sftp) { // Check if the internal SFTP object exists (implies connection was made) console.log('Disconnecting from SFTP server.'); await sftp.end(); } // Clean up local test files await fs.unlink(localFileToUpload).catch(() => {}); await fs.unlink(localFileToDownload).catch(() => {}); console.log('Local temporary files cleaned up.'); } } sftpExample();