appleboy/SCP Command to Transfer Files

Easily transfer files and folders using the SCP command in Linux.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
hostRemote host address for SCP (e.g., example.com or 192.168.1.1).
portRemote SSH port for SCP. Default: 22.22
usernameUsername for SSH authentication.
passwordPassword for SSH authentication (not recommended; use SSH keys if possible).
protocolIP protocol to use. Valid values: 'tcp', 'tcp4', or 'tcp6'. Default: tcp.tcp
timeoutTimeout for establishing SSH connection to the remote host. Default: 30s.30s
command_timeoutTimeout for the SCP command execution. Default: 10m.10m
keyContent of the SSH private key (e.g., the raw content of ~/.ssh/id_rsa).
key_pathPath to the SSH private key file.
passphrasePassphrase for the SSH private key, if required.
fingerprintSHA256 fingerprint of the host's public key. If not set, host key verification is skipped (not recommended for production).
use_insecure_cipherEnable additional, less secure ciphers for compatibility. Not recommended unless required.
targetTarget directory path on the remote server. Must be a directory.
sourceList of files or directories to transfer (local paths).
rmRemove the target directory on the server before uploading new data.
debugEnable debug messages for troubleshooting.
strip_componentsRemove the specified number of leading path elements when extracting files.
overwriteUse the --overwrite flag with tar to overwrite existing files.
tar_dereferenceUse the --dereference flag with tar to follow symlinks.
tar_tmp_pathTemporary path for the tar file on the destination host.
tar_execPath to the tar executable on the destination host. Default: tar.tar
proxy_hostRemote host address for SSH proxy.
proxy_portSSH proxy port. Default: 22.22
proxy_usernameUsername for SSH proxy authentication.
proxy_passwordPassword for SSH proxy authentication.
proxy_passphrasePassphrase for the SSH proxy private key, if required.
proxy_timeoutTimeout for establishing SSH connection to the proxy host. Default: 30s.30s
proxy_keyContent of the SSH proxy private key (e.g., the raw content of ~/.ssh/id_rsa).
proxy_key_pathPath to the SSH proxy private key file.
proxy_fingerprintSHA256 fingerprint of the proxy host's public key. If not set, host key verification is skipped (not recommended for production).
proxy_use_insecure_cipherEnable additional, less secure ciphers for the proxy connection. Not recommended unless required.
curl_insecureWhen true, uses the --insecure option with curl for insecure downloads.false
capture_stdoutWhen true, captures and returns standard output from the commands as action output.false
versionThe version of drone-scp to use.
namedescription
stdoutStandard output of the executed commands when capture_stdout is enabled.