Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

sftp-node

kenichishibata312.4kMIT0.0.8

a simple sftp client built on top of ssh2

sftp, ssh, ssh2, upload, get, download, kenichi, shibata, kenichi.shibata

readme

NPM Build Status

sftp

No nonsense sftp client module for nodejs

Why?

Because most of the sftp upload functions does not work well for me

functions

upload(credentials,remoteFilePath,localFilePath)

Uploads the file

var fs = require('fs');
var sftp = require('sftp-node');

var options = {
  host: '52.69.94.92',
  port: '22',
  username: 'ken',
  privateKey: './key'
};

sftp.upload(options, '/home/ken/testfile', './testfile', function(err,res){
  if(err) console.log('err: '+err);
  else{
    console.log('res: '+res);
  }
});

That's it! 3 lines of code then it uploads your file!

No defaults! defaults sucks and makes it hard to debug

Now go and tell your boss that you are awesome!

TODO

many functions add password? add async?