(Node.js) SFTP Upload - Synchronize Directory Tree

See more SFTP Examples

Demonstrates how to upload files to synchronize a local directory tree with a remote directory tree. The SyncTreeUpload method recursively descends a local directory tree and uploads files based on existence, last-mod date/time and/or size differences.

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

    // This example requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    var sftp = new chilkat.SFtp();

    var success = sftp.Connect("my-ssh-server.com",22);
    if (success == true) {
        success = sftp.AuthenticatePw("mySshLogin","mySshPassword");
    }

    if (success == true) {
        success = sftp.InitializeSftp();
    }

    if (success !== true) {
        console.log(sftp.LastErrorText);
        return;
    }

    // Synchronize (by uploading) the local directory tree rooted at "qa_data/sftpUploadTree"
    // with the remote directory tree rooted at "syncUploadTest"
    // Both directories are relative paths.  The remote directory
    // is relative to the HOME directory of the SSH user account.
    // The local directory is relative to the current working directory of the process.
    // It is also possible to use absolute paths.

    var remoteDir = "syncUploadTest";
    var localDir = "qa_data/sftpUploadTree";

    // Possible modes that can be passed to the SyncTreeUpload method are:
    // mode=0: Upload all files
    // mode=1: Upload all files that do not exist on the server.
    // mode=2: Upload newer or non-existant files.
    // mode=3: Upload only newer files. If a file does not already exist on the server, it is not uploaded.
    // mode=4: transfer missing files or files with size differences.
    // mode=5: same as mode 4, but also newer files.

    // This example will use mode 5 to upload missing, newer, or files with size differences.
    var mode = 5;
    // This example turns on recursion to synchronize the entire tree. 
    // Recursion can be turned off to synchronize the files of a single directory.
    var recursive = true;
    success = sftp.SyncTreeUpload(localDir,remoteDir,mode,recursive);
    if (success !== true) {
        console.log(sftp.LastErrorText);
        return;
    }

    console.log("Success.");

}

chilkatExample();