Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Upload files to an FTP-server
JavaScript
Branch: master
#1 Compare This branch is 2 commits ahead, 36 commits behind sindresorhus:master.

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
.editorconfig
.gitattributes
.gitignore
.jshintrc
.travis.yml
index.js
package.json
readme.md
test.js

readme.md

gulp-ftp Build Status

Upload files to an FTP-server

Useful for uploading and deploying things.

Install

Install with npm

npm install --save-dev gulp-ftp

Example

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

gulp.task('default', function () {
    gulp.src('src/*')
        .pipe(ftp({
            host: 'website.com',
            user: 'johndoe',
            pass: '1234'
        }));
});

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.

Doesn't have to exist as jsftp-mkdirp is used.

options.localPath

Type: String Default '.'

The local path to upload from. This is useful for example when you use

gulp.src('_public/js/*').pipe({remotePath: '/www/some/path'});

And you want the contents of _public/js to be uploaded to /www/some/path, but not _public/js itself. Then you just set localPath to _public/js and you are done.

options.logFiles

Type: Boolean Default: true

Logging of files as they are uploaded. If set to false, you will only see a message when all files finished.

License

MIT © Sindre Sorhus

Something went wrong with that request. Please try again.