(Node.js) SFTP Upload from Local Filesystem

Demonstrates how to upload a file to an SSH server. There are no limitations on file size, and the file is streamed directly from the local filesystem.

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 assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    var sftp = new chilkat.SFtp();

    // Set some timeouts, in milliseconds:
    sftp.ConnectTimeoutMs = 5000;
    sftp.IdleTimeoutMs = 10000;

    // Connect to the SSH server.  
    // The standard SSH port = 22
    // The hostname may be a hostname or IP address.
    var hostname = "sftp.example.com";
    var port = 22;
    var success = sftp.Connect(hostname,port);
    if (success !== true) {
        console.log(sftp.LastErrorText);
        return;
    }

    // Authenticate with the SSH server.  Chilkat SFTP supports
    // both password-based authenication as well as public-key
    // authentication.  This example uses password authenication.
    success = sftp.AuthenticatePw("myLogin","myPassword");
    if (success !== true) {
        console.log(sftp.LastErrorText);
        return;
    }

    // After authenticating, the SFTP subsystem must be initialized:
    success = sftp.InitializeSftp();
    if (success !== true) {
        console.log(sftp.LastErrorText);
        return;
    }

    // Open a file for writing on the SSH server.
    // If the file already exists, it is overwritten.
    // (Specify "createNew" instead of "createTruncate" to
    // prevent overwriting existing files.)
    var handle = sftp.OpenFile("hamlet.xml","writeOnly","createTruncate");
    if (sftp.LastMethodSuccess !== true) {
        console.log(sftp.LastErrorText);
        return;
    }

    // Upload from the local file to the SSH server.
    success = sftp.UploadFile(handle,"c:/temp/hamlet.xml");
    if (success !== true) {
        console.log(sftp.LastErrorText);
        return;
    }

    // -----------------------------------------------------------------------------
    // This is important.  You must close the handle on the server.
    // Otherwise open handles will accumulate on the server until eventually a limit
    // is reached and the server will fail on a call to OpenFile.
    // -----------------------------------------------------------------------------

    // Close the file.
    success = sftp.CloseHandle(handle);
    if (success !== true) {
        console.log(sftp.LastErrorText);
        return;
    }

    console.log("Success.");

}

chilkatExample();