Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/popomore/gulp-scp2
Copy file to remote server, using scp2 that is a pure javascript implement.
https://github.com/popomore/gulp-scp2
Last synced: 2 months ago
JSON representation
Copy file to remote server, using scp2 that is a pure javascript implement.
- Host: GitHub
- URL: https://github.com/popomore/gulp-scp2
- Owner: popomore
- Created: 2014-05-23T02:17:44.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-05-26T03:27:45.000Z (over 7 years ago)
- Last Synced: 2024-11-01T09:33:52.331Z (2 months ago)
- Language: JavaScript
- Size: 153 KB
- Stars: 27
- Watchers: 4
- Forks: 8
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
Awesome Lists containing this project
README
# gulp-scp2 [](https://travis-ci.org/popomore/gulp-scp2) [](https://coveralls.io/r/popomore/gulp-scp2?branch=master)
Copy file to remote server, using scp2 that is a pure javascript implement.
---
## Install
```
$ npm install gulp-scp2 -g
```
## Usage
```
var gulp = require('gulp');
var scp = require('gulp-scp2');
gulp.task('default', function() {
return gulp.src('**/*.js')
.pipe(scp({
host: 'localhost',
username: 'username',
password: 'password',
dest: '/home/username/'
}))
.on('error', function(err) {
console.log(err);
});
});
```
More see [example](https://github.com/popomore/gulp-scp2/blob/master/examples/gulpfile.js)
## Options
### options.host
Type: `String`
Default value: `localhost`
A string value that is the host of the server.
### options.port
Type: `Number`
Default value: `22`
The ssh port of the server.
### options.username
Type: `String`
Default value: `admin`
The username of the server.
### options.password
Type: `String`
The password of the user on the remote server.
### options.dest
Type: `String`
Default value: `/home/username`
Remote server directory
### options.watch
Type: `Function`
You can get the `client` instance, and watch events.
### More Options
- host
- port
- hostHash
- hostVerifier
- username
- password
- agent
- privateKey
- passphrase
- publicKey
Read more: https://github.com/mscdex/ssh2#connection-methods
## LISENCE
Copyright (c) 2015 popomore. Licensed under the MIT license.