[DEPRECATED] Upload files to an FTP-server
JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.editorconfig minor tweaks May 2, 2015
.gitattributes tweaks Aug 14, 2014
.gitignore
.jshintrc minor tweaks May 2, 2015
.travis.yml fix tests Feb 8, 2015
index.js use `plur` Jun 21, 2015
license tweaks Aug 14, 2014
package.json
readme.md deprecate Mar 15, 2015
test.js use `path-exists` module as `fs.exists` is being deprecated May 2, 2015

readme.md

gulp-ftp Build Status

Deprecated in favor of vinyl-ftp.

Upload files to an FTP-server

Useful for uploading and deploying things.

Install

$ npm install --save-dev gulp-ftp

Usage

var gulp = require('gulp');
var gutil = require('gulp-util');
var ftp = require('gulp-ftp');

gulp.task('default', function () {
    return gulp.src('src/*')
        .pipe(ftp({
            host: 'website.com',
            user: 'johndoe',
            pass: '1234'
        }))
        // you need to have some kind of stream after gulp-ftp to make sure it's flushed
        // this can be a gulp plugin, gulp.dest, or any kind of stream
        // here we use a passthrough stream
        .pipe(gutil.noop());
});

API

ftp(options)

options.host

Required
Type: string

options.port

Type: number
Default: 21

options.user

Type: string
Default: 'anonymous'

options.pass

Type: string
Default: '@anonymous'

options.remotePath

Type: string
Default: '/'

The remote path to upload too.

Nonexistent directories will be created for you.

License

MIT © Sindre Sorhus