lets-ftp

Lets-ftp manages FTP connections and commands in Lets. If you want to deploy over FTP, check out lets-copy.

Installation

npm install lets-ftp

Getting started

Letsfile.js

varftp=require('lets-ftp');module.exports=function(lets){varstage=newlets.Stage({host: '1.2.3.4',username: 'me'});// Best practice is to load passwords from a file that isn't checked instage.config(require('./config/stage1'));// Use lets-ftpstage.plugin(ftp());// Do something after connection, maybe upload a filestage.after('connect',function(options,done){this.getConnection(function(c){c.put('local-filename','remote-filename',done);});});// Add stage to lets and name itlets.addStage('stage1',stage);};

Run it using e.g. $ lets deploy stage1 (a way to add custom "flows" will be available soon).

Options

Required:

• options.host – Address to server
• options.username – User to log in with
• options.password – The user's password

See node-ftp for the following options mainly used by that module:

• options.port
• options.secure
• options.secureOptions
• options.connTimeout
• options.pasvTimeout
• options.keepalive

That's also where you can find docs on which methods are available on the connection object.

Contribution

See guidelines for lets.