Awesome Open Source
Awesome Open Source
Sponsorship

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


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
javascript (65,979
nodejs (3,444
gulp (195
deprecated (171
ftp (76
gulp-plugin (46

Find Open Source By Browsing 7,000 Topics Across 59 Categories