https://github.com/wankdanker/node-sftpjs

sftp api similar to mscdex/node-ftp using ssh2
https://github.com/wankdanker/node-sftpjs

Last synced: 2 months ago
JSON representation

sftp api similar to mscdex/node-ftp using ssh2

• Host: GitHub
• URL: https://github.com/wankdanker/node-sftpjs
• Owner: wankdanker
• Created: 2015-07-28T19:44:45.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2022-03-15T15:06:54.000Z (almost 3 years ago)
• Last Synced: 2024-11-02T01:05:46.709Z (2 months ago)
• Language: JavaScript
• Size: 14.6 KB
• Stars: 6
• Watchers: 2
• Forks: 9
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
sftpjs

-------

This module provides quick access to the sftp functionality in mscdex/ssh2. In addition

it attempts to create an API that is similar to mscdex/node-ftp with the intent of making

them interchangable.

status

------

I intend on implementing the following methods in a compatible way with mscdex/node-ftp:

* .connect() - done

* .end() - done

* .list() - done

* .get() - done

* .put() - done

* .mkdir() - done

* .rename() - done

* .delete() - done

All other methods will be the same as defined in [ssh2-streams/SFTPStream](https://github.com/mscdex/ssh2-streams/blob/master/SFTPStream.md#sftpstream-methods).

example

-------

```js

var Client = require('sftpjs');

var c = Client();

c.on('ready', function () {

  c.list(function (err, list) {

    if (err) throw err;

    console.dir(list);

    c.end();

  });

}).connect({

  host : 'thanks'

  , user : 'for'

  , password : 'allthefish'

});

```

install

-------

```shell

npm install sftpjs

```

api

---

* **(constructor)**() - Creates and returns a new SFTP client instance

* **connect** - see https://github.com/mscdex/ssh2/blob/master/README.md#client-methods

license

-------

MIT