Giter Club home page Giter Club logo

gulp-ftp's Introduction

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.