scp2

scp2

A pure javascript secure copy program based on ssh2.

---

scp2 is greatly powered by ssh2, implemented the scp in a sftp way.

It is written in pure javascript, and should work on every OS, even Windows. Nodejs (v0.8.7 or newer) is required to make it work.

Install

You can either use it as a library, or a program. For Windows users who miss scp on unix/linux world, you can get the command line now:

$ npm install scp2 -g

You will get a command line tool scp2, and let's try:

$ scp2 -h

Get the development version from ninja channel:

$ npm install scp2@ninja

High level API

Get the client:

var client = require('scp2')

Copy a file to the server:

client.scp('file.txt', 'admin:[e-mail]:/home/admin/', function(err) {
})

Copy a file to the server in another way:

client.scp('file.txt', {
    host: 'example.com',
    username: 'admin',
    password: 'password',
    path: '/home/admin/'
}, function(err) {})

Copy a file to the server and rename it:

client.scp('file.txt', 'admin:[e-mail]:/home/admin/rename.txt', function(err) {
})

Copy a directory to the server:

client.scp('data/', 'admin:[e-mail]:/home/admin/data/', function(err) {
})

Copy via glob pattern:

client.scp('data/*.js', 'admin:[e-mail]:/home/admin/data/', function(err) {
})

Download a file from server:

client.scp('admin:[e-mail]:/home/admin/file.txt', './', function(err) {
})

Download a file from server in another way:

client.scp({
    host: 'example.com',
    username: 'admin',
    password: 'password',
    path: '/home/admin/file.txt'
}, './', function(err) {})

TODO: download via glob pattern.

Low level API

The get client:

var Client = require('scp2').Client;

The high level client is an instance of Client, but it contains the high level API scp.

Methods

• defaults function({})

  set the default values for the remote server.

  client.defaults({
      port: 22,
      host: 'example.com',
      username: 'admin',
      privateKey: '....'
  });
  

  You can also initialize the instance with these values:

  var client = new Client({
      port: 22
  });
  

  More on the values at ssh2.

• sftp function(callback) -> callback(err, sftp)

  Get the sftp.

• close function()

  Close all sessions.

• mkdir function(dir, [attr], callback) -> callback(err)

  Make a directory on the remote server. It behaves like mdkir -p.

• write function(options, callback) -> callback(err)

  Write content on the remote server.

  client.write({
      destination: '/home/admin/data/file.txt',
      content: 'hello world'
  }, callback)
  

  The options can contain:

  • destination
  • content: string or buffer
  • attrs
  • source: the source path, e.g. local/file.txt

• upload function(src, dest, callback) -> callback(err)

  upload a local file to the server.

  client.upload('file.txt', '/home/admin/file.txt', callback)
  

• download function(src, dest, callback) -> callback(err)

  download a server file to local.

Events

You can listen on these events:

• connect
• ready
• error (err)
• end
• close
• mkdir (dir)
• write (object)
• read (src)

Changelog

2013-03-05 0.1.0a1 ~ ninja

1. Init the program, take the name scp2 in npmjs.org.
2. scp to server works.

2013-03-06 0.1.0a2 ~ ninja

1. Download a file from server works.
2. Documentation on this lib.

2013-03-06 0.1.0a3 ~ ninja

1. Fix path bug on windows.
2. Pretty output log.