basic-sftp

Basic SFTP

🤹🏻‍♀️ A basic promise-based SFTP Client

Install

   npm i basic-sftp

Usage

Import

• ES Modules

  import { Client } from 'basic-sftp';
  

• CommonJS

  const { Client } = require('basic-sftp');
  

Connect

const sftp = new Client();

await sftp.connect({
   host: '',
   port: 22,
   username: '',
   password: '',
});

• The connection access extends all the ssh2 options

Reconnect

await sftp.reconnect();

Close Connection

await sftp.end();

Methods

ls

• Lists the contents of a directory

  await sftp.ls(path);
  

is

• Get the type from path: File | Directory | null

  await sftp.is(path);
  

  • File means that the remote path is a file
  • Directory means that the remote path is a directory
  • null means that the remote path doesn't exist

ensureDir

• Creates the path recursively, if it does not exist

  await sftp.ensureDir(path);
  

uploadFile

• Uploads a local file to the remote server

  await sftp.uploadFile(localPath, remotePath);
  

downloadFile

• Downloads a remote file to the local workspace

  await sftp.downloadFile(remotePath, localPath);
  

unlink

• Remove all files and directories from a directory, including the directory itself, if it exists

  await sftp.unlink(path);
  

getConnection

• Brings up the original ssh2.sftp methods

  sftp.getConnection();
  

• Features
  • ls
  • is
  • ensureDir
  • unlink
  • uploadFile
  • downloadFile
  • uploadDir
  • downloadDir

Credits

Contributions	GitHub
Author