Package Exports

node-scp

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (node-scp) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

New SCP module for NodeJS

A lightweight, fast and secure module to perform SCP commands for NodeJS based on SSH2

What's new

All functionalities are written using Promise. That means you can use it with Promise or Async/Await (No more callback hell, Yeah :) )

And other new features:

Scp a directory from local to remote server and from remote to local
Perform commands on remote server: mkdir, stat, check if path exists

Install

npm install --save node-scp
# or
yarn install node-scp

Guide

Scp file from local to remote server

Using Promise

const scp = require('node-scp')

scp({
  host: 'your host',
  port: 22,
  username: 'username',
  password: 'password',
}).then(client => {
  client.uploadFile('./test.txt', '/workspace/test.txt')
        .then(response => {
          client.close() // remember to close connection after you finish
        })
        .catch(error => {})
}).catch(e => console.log(e))

Using async/await:

const scp = require('node-scp')

async function test() {
  try {
    const c = await scp({
      host: 'your host',
      port: 22,
      username: 'username',
      password: 'password',
    })
    await c.uploadFile('./test.txt', '/workspace/test.txt')
    c.close() // remember to close connection after you finish
  } catch (e) {
    console.log(e)
  }
}

test()

Scp file from remote server to local

Using Promise

const scp = require('node-scp')

scp({
  host: 'your host',
  port: 22,
  username: 'username',
  password: 'password',
}).then(client => {
  client.downloadFile('/workspace/test.txt', './test.txt')
        .then(response => {
          client.close() // remember to close connection after you finish
        })
        .catch(error => {})
}).catch(e => console.log(e))

Using async/await:

const scp = require('node-scp')

async function test () {
  try {
    const client = await scp({
      host: 'your host',
      port: 22,
      username: 'username',
      password: 'password',
    })
    await client.downloadFile('/workspace/test.txt', './test.txt')
    client.close() // remember to close connection after you finish
  } catch(e) {
    console.log(e)
  }
}

test()

Scp a directory from local to remote server

Using Promise

const scp = require('node-scp')

scp({
  host: 'your host',
  port: 22,
  username: 'username',
  password: 'password',
}).then(client => {
  client.uploadDir('./local/dir', '/server/path')
        .then(response => {
          client.close() // remember to close connection after you finish
        })
        .catch(error => {})
}).catch(e => console.log(e))

Using async/await:

const scp = require('node-scp')

async funtion test () {
  try {
    const client = await scp({
      host: 'your host',
      port: 22,
      username: 'username',
      password: 'password',
    })
    await client.uploadDir('./local/dir', '/server/path')
    client.close() // remember to close connection after you finish
  } catch (e) {
    console.log(e)
  }
}

test()

Create a directory on remote server

Using Promise

const scp = require('node-scp')

scp({
  host: 'your host',
  port: 22,
  username: 'username',
  password: 'password',
}).then(client => {
  client.mkdir('/server/path')
        .then(response => {
          client.close() // remember to close connection after you finish
        })
        .catch(error => {})
}).catch(e => console.log(e))

Using async/await:

const scp = require('node-scp')

async function test() {
  try {
    const client = await scp({
      host: 'your host',
      port: 22,
      username: 'username',
      password: 'password',
    })
    await client.mkdir('/server/path')
    client.close() // remember to close connection after you finish
  } catch (e) {
    console.log(e)
  }
}

test()

Check if a path exists on remote server

Using Promise

const scp = require('node-scp')

scp({
  host: 'your host',
  port: 22,
  username: 'username',
  password: 'password',
}).then(client => {
  client.exists('/server/path')
        .then(response => {
          client.close() // remember to close connection after you finish
        })
        .catch(error => {})
}).catch(e => console.log(e))

Using async/await:

const scp = require('node-scp')
async function test() {
  try {
    const client = await scp({
      host: 'your host',
      port: 22,
      username: 'username',
      password: 'password',
    })
    await client.exists('/server/path')
    client.close() // remember to close connection after you finish
  } catch (e) {
    console.log(e)
  }
}

test()

Get stats of a path on remote server

Using Promise

const scp = require('node-scp')

scp({
  host: 'your host',
  port: 22,
  username: 'username',
  password: 'password',
}).then(client => {
  client.stat('/server/path')
        .then(response => {
          client.close() // remember to close connection after you finish
        })
        .catch(error => {})
}).catch(e => console.log(e))

Using async/await:

const scp = require('node-scp')

async function test() {
  try {
    const client = await scp({
      host: 'your host',
      port: 22,
      username: 'username',
      password: 'password',
    })
    await client.stat('/server/path')
    client.close() // remember to close connection after you finish
  } catch (e) {
    console.log(e)
  }
}

test()

Support

If you like this project, give me 1 ⭐️