SSH and SFTP tasks for Grunt.
This plugin requires Grunt ~0.4.0
This library provides two Grunt tasks for ssh:
- sftp
- sshexec
This plugin was designed to work with Grunt 0.4.x. If you're still using grunt v0.3.x it's strongly recommended that you upgrade, but in case you can't please use v0.1.0.
// don't keep passwords in source control
secret: grunt.file.readJSON('secret.json'),
sftp: {
test: {
files: {
"./": "*json"
},
options: {
path: '/tmp/',
host: '<%= secret.host %>',
username: '<%= secret.username %>',
password: '<%= secret.password %>'
}
}
},
sshexec: {
test: {
command: 'uptime',
options: {
host: '<%= secret.host %>',
username: '<%= secret.username %>',
password: '<%= secret.password %>'
}
}
}Copies one or more files to a remote server over ssh.
Inside your grunt.js file add a section named sftp.
The files to copy. Should contain key:value pairs.
The path on the remote server. Defaults to home.
Options for minimatch.
The username to authenticate as on remote system.
The password to authenticate on remote system.
A string containing the contents of the private key to use to authenticate with the remote system, you can load this from a file using grunt.file.load. Be careful you don't put this into source control unless you mean it!
options: {
privateKey: grunt.file.load("id_rsa"),
passphrase: <%= secret.passphrase %>
}The passphrase to use with the privateKey. As per the privateKey, do not expose this in your Gruntfile or anywhere that'll end up public unless you mean it, load it from an external file.
The remote host to copy to, set up in your ~/.ssh/config.
The remote port, optional, defaults to 22.
Optionally strip off an initial part of the file when performing the SFTP operation. This is a string operation, so trailing slashes are important.
For example:
/* [...] */
files: {
"./": "dist/**"
},
options: {
path: '/tmp/',
/* [...] */
srcBasePath: "dist/"Would SFTP the files in dist directly into tmp (eg. dist/index.html ==> /tmp/index.html)
Runs a command over ssh.
Inside your grunt.js file add a section named sshexec.
The command to run.
The username to authenticate as on remote system.
The password to authenticate on remote system.
The remote host to copy to, set up in your ~/.ssh/config.
The remote port, optional, defaults to 22.
- 2013/02/26 - v0.2.1 - Add
srcBasePathoption tosftp. Thanks to marcins. - 2013/02/20 - v0.2.0 - Update for grunt 0.4.x.
- 2013/02/13 - v0.1.0 - Initial release with sshexec and sftp tasks.
Copyright (c) 2013 Andrew Jones Licensed under the MIT license.