Skip to content

Commit 22fa042

Browse files
author
Cam Pedersen
committed
Merge pull request #2 from gabrielpreston/master
[doc] Update to README
2 parents 32dbf15 + ec2a852 commit 22fa042

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ var scp = require('scp');
1515

1616
var options = {
1717
file: 'dump.sql'
18+
user: 'username',
1819
host: 'myServer',
1920
path: '~'
2021
}
@@ -33,11 +34,12 @@ Send a file to a remote host (in your `~/.ssh/config`)
3334

3435
You must pass in `options`. A `cb` function is optional, and will be passed `err`, `stdout`, and `stderr`.
3536

36-
There are currently 3 options:
37+
There are currently 4 options:
3738

3839
````javascript
3940
scp.send({
4041
file: './file.txt', // local file to send
42+
user: 'username', // username to authenticate as on remote system
4143
host: 'myServer', // remote host to copy to, set up in your ~/.ssh/config
4244
path: '~' // remote path to save to (this would result in a ~/file.txt on myServer)
4345
});
@@ -54,6 +56,7 @@ There are currently 3 options:
5456
````javascript
5557
scp.get({
5658
file: '~/file.txt', // remote file to grab
59+
user: 'username', // username to authenticate as on remote system
5760
host: 'myServer', // remote host to transfer from, set up in your ~/.ssh/config
5861
path: '~' // local path to save to (this would result in a ~/file.txt on the local machine)
5962
});

0 commit comments

Comments
 (0)