# sftp-node

> a simple sftp client built on top of ssh2

Latest version **0.0.8** (published 2018-03-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install sftp-node
pnpm add sftp-node
yarn add sftp-node
bun add sftp-node
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.8 |
| Published | 2018-03-02 |
| First published | 2016-01-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 3.3 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Kenichi Shibata |
| Maintainers | kenichi.shibata |
| Keywords | sftp, ssh, ssh2, upload, get, download, kenichi, shibata, kenichi.shibata |

## Links

- npm: https://www.npmjs.com/package/sftp-node
- Repository: https://github.com/kenichishibata31/sftp
- Homepage: https://github.com/kenichishibata31/sftp#readme
- Issues: https://github.com/kenichishibata31/sftp/issues
- npm.io page: https://npm.io/package/sftp-node

## Dependencies (1)

- [ssh2](https://npm.io/package/ssh2.md) ^0.5.0

## Recent versions

- 0.0.8 (latest) — 2018-03-02
- 0.0.7 — 2017-11-30
- 0.0.6 — 2016-07-11
- 0.0.5 — 2016-01-13

## README

[![NPM](https://nodei.co/npm/sftp-node.png?downloads=true&downloadRank=true&stars=true)](https://npmjs.org/package/sftp-node)
[![Build Status](https://travis-ci.org/kenichishibata31/sftp.svg)](https://travis-ci.org/kenichishibata31/sftp)

# 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?

---
_Source: https://npm.io/package/sftp-node · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._