(Node.js) SCP Upload to a Specific Remote Directory

Demonstrates how to upload a file using the SCP protocol (Secure Copy Protocol over SSH). The file is uploaded to a specific remote directory. It can be either a path relative to the HOME directory of the SSH user account, or an absolute path on the remote filesystem. Obviously, in both cases the SSH user account must have permission to create or overwrite a file in the specified directory.

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 ssh = new chilkat.Ssh();

    // Connect to an SSH server:
    var hostname;
    var port;

    // Hostname may be an IP address or hostname:
    hostname = "www.some-ssh-server.com";
    port = 22;

    var success = ssh.Connect(hostname,port);
    if (success !== true) {
        console.log(ssh.LastErrorText);
        return;
    }

    // Wait a max of 5 seconds when reading responses..
    ssh.IdleTimeoutMs = 5000;

    // Authenticate using login/password:
    success = ssh.AuthenticatePw("myLogin","myPassword");
    if (success !== true) {
        console.log(ssh.LastErrorText);
        return;
    }

    // Once the SSH object is connected and authenticated, we use it
    // as the underlying transport in our SCP object.
    var scp = new chilkat.Scp();

    success = scp.UseSsh(ssh);
    if (success !== true) {
        console.log(scp.LastErrorText);
        return;
    }

    // This uploads a file to the "uploads/text" directory relative to the HOME
    // directory of the SSH user account.  For example, if the HOME directory is /home/chilkat,
    // then this uploads to /home/chilkat/uploads/text/test.txt
    // Note: The remote target directory must already exist on the SSH server.
    var remotePath = "uploads/text/test.txt";
    var localPath = "/home/bob/test.txt";
    success = scp.UploadFile(localPath,remotePath);
    if (success !== true) {
        console.log(scp.LastErrorText);
        return;
    }

    // This upload fully specifies the absolute remote path.
    remotePath = "/home/chilkat/junk/abc/hamlet.xml";
    localPath = "/home/bob/hamlet.xml";
    success = scp.UploadFile(localPath,remotePath);
    if (success !== true) {
        console.log(scp.LastErrorText);
        return;
    }

    console.log("SCP upload file success.");

    // Disconnect
    ssh.Disconnect();

}

chilkatExample();