sshkit v0.0.1 SSHKit.SCP

Provides convenience functions for transferring files or directory trees to or from a remote host via SCP.

Built on top of SSHKit.SSH.

Common options

These options are available for both uploads and downloads:

:verbose - let the remote scp process be verbose, default false
:recursive - set to true for copying directories, default false
:preserve - preserve timestamps, default false
:timeout - timeout in milliseconds, default :infinity

Examples

{:ok, conn} = SSHKit.SSH.connect('eg.io', user: 'me')
:ok = SSHKit.SCP.upload(conn, '.', '/home/code/phx', recursive: true)
:ok = SSHKit.SSH.close(conn)

Summary

Functions

download(connection, remote, local, options \\ [])

Downloads a file or directory from a remote host

upload(connection, local, remote, options \\ [])

Uploads a local file or directory to a remote host

Functions

download(connection, remote, local, options \\ [])

Downloads a file or directory from a remote host.

Options

See SSHKit.SCP.Download.transfer/4.

Example

:ok = SSHKit.SCP.download(conn, '/var/backups', 'backups', recursive: true)

upload(connection, local, remote, options \\ [])

Uploads a local file or directory to a remote host.

Options

See SSHKit.SCP.Upload.transfer/4.

Example

:ok = SSHKit.SCP.upload(conn, '.', '/home/code/sshkit', recursive: true)