node-scpCopy files over SSH, to any server

Copy a folder in three lines ​

import { connect } from 'node-scp';

await using client = await connect({ host: 'example.com', username: 'deploy', privateKey });
await client.upload('./dist', '/var/www/app', { recursive: true });

import { upload } from 'node-scp';

await upload('./dist', 'deploy@example.com:/var/www/app', { recursive: true, privateKey });

npx node-scp -r ./dist deploy@example.com:/var/www/app

- uses: maitrungduc1410/node-scp-async@v1
  with:
    host: ${{ secrets.DEPLOY_HOST }}
    username: deploy
    private-key: ${{ secrets.DEPLOY_KEY }}
    source: dist/
    target: /var/www/app

Works with the servers you actually have ​

Pick a server to see what node-scp does with it.

await connect({ host: 'example.com', username: 'deploy', privateKey });

How it picks the protocol ​

Fast where it matters ​

Uploads to OpenSSH on the same machine, mean of several runs. Most of the gap on small files comes from TCP_NODELAY; the comparison page explains it.