node-scp

Copy files to and from SSH servers over SFTP or SCP.

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 });

Modules

• legacy
• scp2

Classes

• RemoteFs
• ScpClient
• ScpError

Interfaces

• ConnectOptions
• EntryInfo
• MkdirOptions
• ReadFileOptions
• RemoteEntry
• RemoteStats
• RemoteTarget
• RmOptions
• ScpErrorOptions
• TransferOptions
• TransferProgress
• TransferResult
• WriteFileOptions

Type Aliases

• ActiveProtocol
• CopyOptions
• EntryType
• ErrorCode
• Protocol
• RemoteOs

Variables

• ErrorCode

Functions

• connect
• download
• formatTarget
• isScpError
• parseTarget
• upload