# vinyl-ftp > Vinyl adapter for FTP Latest version **0.6.1** (published 2018-01-27) · MIT license · 0 weekly downloads ## Install ```sh npm install vinyl-ftp pnpm add vinyl-ftp yarn add vinyl-ftp bun add vinyl-ftp ``` ## Health **Score 25/100 (F)** — status: abandoned. Positive: has types; no vulnerabilities; high quality score. Warnings: low downloads; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.6.1 | | Published | 2018-01-27 | | First published | 2015-01-16 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Node | >=0.10.0 | | Dependencies | 6 | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 389 | | Author | Morris Brodersen | | Maintainers | morris4 | | Keywords | vinyl, gulp, ftp, deploy, deployment, upload | ## Links - npm: https://www.npmjs.com/package/vinyl-ftp - Repository: https://github.com/morris/vinyl-ftp - Homepage: https://github.com/morris/vinyl-ftp#readme - Issues: https://github.com/morris/vinyl-ftp/issues - npm.io page: https://npm.io/package/vinyl-ftp ## Dependencies (6) - [ftp](https://npm.io/package/ftp.md) ^0.3.8 - [vinyl](https://npm.io/package/vinyl.md) ^2.0.1 - [through2](https://npm.io/package/through2.md) ^2.0.3 - [minimatch](https://npm.io/package/minimatch.md) ^3.0.2 - [object-assign](https://npm.io/package/object-assign.md) ^4.1.1 - [parallel-transform](https://npm.io/package/parallel-transform.md) ^1.1.0 ## Recent versions - 0.6.1 (latest) — 2018-01-27 - 0.6.0 — 2017-02-05 - 0.5.0 — 2016-06-18 - 0.4.5 — 2015-08-27 - 0.4.4 — 2015-07-14 - 0.4.3 — 2015-07-14 - 0.4.2 — 2015-07-11 - 0.4.1 — 2015-04-28 - 0.4.0 — 2015-03-11 - 0.3.4 — 2015-03-09 - 0.3.3 — 2015-03-07 - 0.3.2 — 2015-03-07 - 0.3.1 — 2015-03-04 - 0.3.0 — 2015-01-29 - 0.2.1 — 2015-01-18 - … 3 more at https://npm.io/package/vinyl-ftp/versions ## README # vinyl-ftp [![version](https://img.shields.io/npm/v/vinyl-ftp.svg)](https://www.npmjs.com/package/vinyl-ftp) [![downloads](https://img.shields.io/npm/dm/vinyl-ftp.svg)](https://www.npmjs.com/package/vinyl-ftp) Blazing fast vinyl adapter for FTP. Supports parallel transfers, conditional transfers, buffered or streamed files, and more. Often performs better than your favorite desktop FTP client. ## Usage Nice and gulpy deployment task: ```javascript var gulp = require( 'gulp' ); var gutil = require( 'gulp-util' ); var ftp = require( 'vinyl-ftp' ); gulp.task( 'deploy', function () { var conn = ftp.create( { host: 'mywebsite.tld', user: 'me', password: 'mypass', parallel: 10, log: gutil.log } ); var globs = [ 'src/**', 'css/**', 'js/**', 'fonts/**', 'index.html' ]; // using base = '.' will transfer everything to /public_html correctly // turn off buffering in gulp.src for best performance return gulp.src( globs, { base: '.', buffer: false } ) .pipe( conn.newer( '/public_html' ) ) // only upload newer files .pipe( conn.dest( '/public_html' ) ); } ); ``` Without Gulp: ```javascript var fs = require( 'vinyl-fs' ); var ftp = require( 'vinyl-ftp' ); var conn = new ftp( /* ... */ ); fs.src( [ './src/**' ], { buffer: false } ) .pipe( conn.dest( '/dst' ) ); ``` *Remember not to push FTP credentials to public repos!* ## API `var ftp = require( 'vinyl-ftp' )` ### ftp.create( config ) Return a new `vinyl-ftp` instance with the given config. Config options: - __host:__ FTP host, default is localhost - __user:__ FTP user, default is anonymous - __pass[word]:__ FTP password, default is anonymous@ - __port:__ FTP port, default is 21 - __log:__ Log function, default is null - __timeOffset:__ Offset server time by this number of minutes, default is 0 - __parallel:__ Number of parallel transfers, default is 3 - __maxConnections:__ Maximum number of connections, should be greater or equal to "parallel". Default is 5, or the parallel setting. Don't worry about setting this too high, vinyl-ftp recovers from "Too many connections" errors nicely. - __reload:__ Clear caches before (each) stream, default is false - __idleTimeout:__ Time to keep idle FTP connections (milliseconds), default is 100 - __debug:__ A debug callback that gets extensive debug information, default is null - __secure:__ Set `true` for secured FTP connections - __secureOptions:__ Set `{ rejectUnauthorized: false }` for self-signed or expired secure FTP connections You can override `parallel` and `reload` per stream in their `options`.
`var conn = ftp.create( config )` ### conn.src( globs[, options] ) STREAM Returns a vinyl file stream that emits remote files matched by the given globs. The remote files have a `file.ftp` property containing remote information. Possible options: - __cwd:__ Set as file.cwd, default is `/`. - __base:__ Set as file.base, default is glob beginning. This is used to determine the file names when saving in .dest(). - __since:__ Only emit files modified after this date. - __buffer:__ Should the file be buffered (complete download) before emitting? Default is true. - __read:__ Should the file be read? Default is true. False will emit null files. Glob-related options are documented at [minimatch](https://www.npmjs.com/package/minimatch).
### conn.dest( remoteFolder[, options] ) STREAM Returns a transform stream that transfers input files to a remote folder. All directories are created automatically. Passes input files through. ### conn.mode( remoteFolder, mode[, options] ) STREAM Returns a transform stream that sets remote file permissions for each file. `mode` must be a string between '0000' and '0777'. ### conn.newer( remoteFolder[, options] ) STREAM Returns a transform stream which filters the input for files which are newer than their remote counterpart. ### conn.differentSize( remoteFolder[, options] ) STREAM Returns a transform stream which filters the input for files which have a different file size than their remote counterpart. ### conn.newerOrDifferentSize( remoteFolder[, options] ) STREAM See above. ### conn.filter( remoteFolder, filter[, options] ) STREAM Returns a transform stream that filters the input using a callback. The callback should be of this form: ```javascript function ( localFile, remoteFile, callback ) { // localFile and remoteFile are vinyl files. // Check remoteFile.ftp for remote information. // Decide wether localFile should be emitted and call callback with boolean. // callback is a function( error, emit ) callback( null, emit ); } ``` ### conn.delete( path, cb ) CALLBACK Deletes a file. ### conn.rmdir( path, cb ) CALLBACK Removes a directory, recursively. ### conn.clean( globs, local[, options] ) STREAM Globs remote files, tests if they are locally available at `/` and removes them if not. ## Development - Run tests with `CONFIG=test/config/yourserver.json npm test` --- _Source: https://npm.io/package/vinyl-ftp · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._