sftp-promises

sftp-promises

SFTP Promise Wrapper for ssh2

Support basic SFTP transaction with promises, specifically for fronting SFTP with a web based API using something like Koa

Warning

Each request will create a new conneciton and close it when finished, this is by design as its intended to be used in stateless web applications. As such care should exercised when using on high traffic systems to avoid too many connections to SFTP server and general connection overhead.

Usage

var config = {host: 'localhost', username: 'user', password: 'pass' };
var SFTPClient = require('sftp-promises');
var sftp = new SFTPClient(config);
     
sftp.ls('~/').then(function(list) { console.log(list) })

config options are the same as ssh2 config options.

Supported calls

• sftp.ls(<string>remote_path) returns a promise with an object descibing the path
• sftp.getBuffer(<string>remote_path) returns a promise with a buffer containing the file contents
• sftp.putBuffer(<Buffer>data, remote_path) returns a promise with a boolean, true if successful
• sftp.get(<string>remote_path, local_path) returns a promise with a boolean, true if successful
• sftp.put(<string>local_path, remote_path) returns a promise with a boolean, true if successful
• sftp.rm(<string>location) returns a promise with a boolean, true if successful
• sftp.mv(<string>src, dest) returns a promise with a boolean, true if successful

Planned Features

• Streaming implementation for get and put
• The option for persistent connections