@leex/rsync v0.0.5

@leex/rsync

Installation

An async wrapper to the rsync command line utility for Node.js, Modified according to rsyncwrapper

npm install @leex/rsync

# Or yarn

yarn add @leex/rsync

Usage

const rsync = require('@leex/rsync')
rsync({ src: 'path/to/src', dest: 'path/to/dest' })

Options

src [String|Array<String>] *required

Path to src. Can be a single filename, or an array of filenames. Shell wildcard expansion is supported. Examples:

src: "./dist/"
src: ["./dir-a/file1","./dir-b/file2"]
src: "./*.foo"
src: "foo{1,2,3}.txt"

dest [String] *required

Path to destination. Example, "/var/www/mysite.tld".

port [String]

If your ssh host uses a non standard SSH port then set it here. Example, "1234".

exclude [Array<String>]

Optional array of rsync patterns to exclude from transfer. Include patterns are defined before exclude patterns when building the rsync command.

args [Array<String>]

Array of additional arbitrary rsync command line options and flags.

For extra information and subtlety relating to rsync options please consult the rsync manpages.