What is ssh2-sftp-client?
The ssh2-sftp-client npm package is a promise-based SFTP client for Node.js, built on top of the ssh2 module. It provides a simple and easy-to-use interface for performing various SFTP operations such as uploading, downloading, listing, and deleting files on a remote server.
What are ssh2-sftp-client's main functionalities?
Connecting to an SFTP server
This feature allows you to establish a connection to an SFTP server using the provided host, port, username, and password.
const Client = require('ssh2-sftp-client');
const sftp = new Client();
sftp.connect({
host: 'example.com',
port: '22',
username: 'username',
password: 'password'
}).then(() => {
console.log('Connected');
}).catch(err => {
console.error(err.message);
});
Uploading a file
This feature allows you to upload a file from your local system to the remote SFTP server.
sftp.put('local/path/to/file.txt', 'remote/path/to/file.txt').then(() => {
console.log('File uploaded');
}).catch(err => {
console.error(err.message);
});
Downloading a file
This feature allows you to download a file from the remote SFTP server to your local system.
sftp.get('remote/path/to/file.txt', 'local/path/to/file.txt').then(() => {
console.log('File downloaded');
}).catch(err => {
console.error(err.message);
});
Listing files in a directory
This feature allows you to list all files and directories in a specified remote directory.
sftp.list('remote/path/to/directory').then(data => {
console.log(data);
}).catch(err => {
console.error(err.message);
});
Deleting a file
This feature allows you to delete a specified file from the remote SFTP server.
sftp.delete('remote/path/to/file.txt').then(() => {
console.log('File deleted');
}).catch(err => {
console.error(err.message);
});
Other packages similar to ssh2-sftp-client
ssh2
The ssh2 package is a general-purpose SSH2 client and server module for Node.js. It provides a lower-level API compared to ssh2-sftp-client, allowing for more granular control over SSH and SFTP operations. However, it requires more boilerplate code to accomplish the same tasks.
node-sftp
The node-sftp package is another SFTP client for Node.js. It offers similar functionalities to ssh2-sftp-client but is less popular and has fewer features. It is also not as actively maintained as ssh2-sftp-client.
scp2
The scp2 package is a client for SCP (Secure Copy Protocol) in Node.js. While it provides functionalities for transferring files over SSH, it is limited to SCP and does not support the full range of SFTP operations that ssh2-sftp-client does.