Sample code for 30+ languages & platforms
React Native

SCP Download from a Specific Directory

See more SCP Examples

Demonstrates how to download a file using the SCP protocol (Secure Copy Protocol over SSH), from a specific remote directory located on the SSH server. The remote directory can be 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 open and read the file in the specified directory.

Chilkat React Native Downloads

React Native
import { Scp, Ssh } from '@chilkat/react-native'

async function chilkatExample() {
  // This example requires the Chilkat API to have been previously unlocked.
  // See Global Unlock Sample for sample code.

  const ssh = new Ssh();

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

  // Connect to an SSH server:
  try {
    await ssh.connectAsync(hostname, port);
  } catch {
    console.log(ssh.lastErrorText);
    return;
  }

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

  // Authenticate using login/password:
  try {
    await ssh.authenticatePwAsync('myLogin', 'myPassword');
  } catch {
    console.log(ssh.lastErrorText);
    return;
  }

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

  try {
    scp.useSsh(ssh);
  } catch {
    console.log(scp.lastErrorText);
    return;
  }

  // This downloads a file from the "testApp/logs/" subdirectory (relative to the SSH user account's HOME directory).  
  // For example, if the HOME directory is /Users/chilkat, then the following downloads
  // /Users/chilkat/testApp/logs/test1.log
  let remotePath = 'testApp/logs/test1.log';
  let localPath = 'c:/testApp/logs/test1.log';
  try {
    await scp.downloadFileAsync(remotePath, localPath);
  } catch {
    console.log(scp.lastErrorText);
    return;
  }

  // The following call to DownloadFile specifies an absolute file path on the SSH server:
  remotePath = '/Users/chilkat/Documents/gecko.jpg';
  localPath = 'c:/temp/images/gecko.jpg';
  try {
    await scp.downloadFileAsync(remotePath, localPath);
  } catch {
    console.log(scp.lastErrorText);
    return;
  }

  console.log('SCP download file success.');

  // Disconnect
  ssh.disconnect();
}