Skip to main content

simple_ssh_copy

Transfer files to and from small or old POSIX-like devices over SSH.

This package intentionally avoids SFTP/SCP subsystems. It only needs a working SSH login and a few basic POSIX shell commands, so it is useful for minimal Linux systems, embedded devices, rescue environments, and older SSH servers.

Features

  • Upload a local file to a remote host.
  • Download a remote file to the local machine.
  • Download a remote directory recursively.
  • Aborts with a yellow warning when the remote system is detected as Windows.
  • Prints the remote architecture detected with uname -m before transfers.
  • Password, empty-password, SSH agent, ~/.ssh key, and explicit private-key authentication.
  • Broad SSH algorithm compatibility enabled by default. During Paramiko transport setup, the client allows every currently supported key exchange, cipher, MAC/digest, server host key, and public-key signature algorithm that can be used by the active Paramiko transport.

For implementation notes, transfer flow, block sizes, and compatibility details, see Technical Details.

Install

pip install simple_ssh_copy

For local development:

pip install -e .

Command Line

Upload a file:

python -m simple_ssh_copy ./test-file.txt root@192.168.1.10:/home/root/test-file.txt

Download a file:

python -m simple_ssh_copy root@192.168.1.10:/home/root/test-file.txt ./test-file.txt

Use a non-default port:

python -m simple_ssh_copy ./test-file.txt root@192.168.1.10:2222:/home/root/test-file.txt

Use an explicit private key:

python -m simple_ssh_copy -i ~/.ssh/id_rsa ./test-file.txt root@192.168.1.10:/home/root/test-file.txt

On Windows:

python -m simple_ssh_copy -i C:\Users\neko\.ssh\id_rsa .\test-file.txt root@169.254.115.127:/home/root/test-file.txt

Increase the SSH timeout:

python -m simple_ssh_copy --timeout 60 ./test-file.txt root@192.168.1.10:/home/root/test-file.txt

When prompted for a password, press Enter for empty-password or key-only login. In that case the client also tries SSH agent and keys discoverable in ~/.ssh.

Python API

import simple_ssh_copy

hostname = "192.168.1.10"
username = "root"
password = ""

simple_ssh_copy.upload(
    hostname=hostname,
    username=username,
    password=password,
    files=[("./test-file.txt", "/home/root/test-file.txt")],
    key_filename="~/.ssh/id_rsa",
)

simple_ssh_copy.download(
    hostname=hostname,
    username=username,
    password=password,
    files=[("/home/root/test-file.txt", "./test-file.txt")],
    key_filename="~/.ssh/id_rsa",
)

simple_ssh_copy.download_dir(
    hostname=hostname,
    username=username,
    password=password,
    remote_dir="/home/root/logs",
    local_dir="./logs",
    key_filename="~/.ssh/id_rsa",
)

Run a remote command with the low-level client:

from simple_ssh_copy import SimpleSSHClient

with SimpleSSHClient(
    hostname="192.168.1.10",
    username="root",
    password="",
    key_filename="~/.ssh/id_rsa",
) as ssh:
    code, stdout, stderr = ssh.exec_cmd("uname -a")

SSH Algorithm Compatibility

Some old devices require options like:

ssh -o HostKeyAlgorithms=+ssh-rsa \
    -o MACs=+hmac-sha1-96,hmac-sha1,hmac-md5 \
    -i ~/.ssh/id_rsa root@192.168.1.10

simple_ssh_copy enables a broader Paramiko-side compatibility mode by default. It advertises all key exchange, cipher, MAC/digest, server host key, and public-key signature algorithms registered by the active Paramiko transport, while preserving Paramiko's default preference order first. It also restores ssh-rsa host keys and RSA public-key signatures when Paramiko can use them.

The matching file-transfer command is usually:

python -m simple_ssh_copy -i ~/.ssh/id_rsa ./file root@192.168.1.10:/tmp/file

If you need stricter modern SSH behavior, pass allow_ssh_rsa_host_key=False from the Python API. The parameter name is kept for API compatibility, but disabling it skips the broader compatibility transport setup.

Path Format

Remote paths use one of these formats:

user@host:/remote/path
user@host:port:/remote/path

Only local-to-remote and remote-to-local transfers are supported. Remote-to- remote transfers are not supported.

Limitations

  • The remote host must provide a POSIX-like shell.
  • Non-POSIX SSH servers, such as Windows command-shell SSH sessions, are not supported. Windows remotes are detected after SSH connection setup and abort with a yellow warning before file operations begin.
  • Transfer startup reports the remote architecture with uname -m.
  • Upload uses mkdir and base64 on the remote host.
  • Upload sends base64 fragments through bounded remote commands, then decodes the assembled temporary file on the remote host.
  • Download uses stat, dd, and find for directory downloads.
  • Directory upload is not implemented.
  • Very large uploads may be slower than real SCP/SFTP because data is written through remote shell commands.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

simple_ssh_copy-0.1.14.tar.gz (13.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

simple_ssh_copy-0.1.14-py3-none-any.whl (15.7 kB view details)

Uploaded Python 3

File details

Details for the file simple_ssh_copy-0.1.14.tar.gz.

File metadata

  • Download URL: simple_ssh_copy-0.1.14.tar.gz
  • Upload date:
  • Size: 13.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.11.15 Windows/10

File hashes

Hashes for simple_ssh_copy-0.1.14.tar.gz
Algorithm Hash digest
SHA256 3e42c0713feca718ee83240a5658f81a69a85457661f26940b3857d14ade837e
MD5 ac8b7e6eca3d033de15fcb9ed0c14a4f
BLAKE2b-256 d17c531795abb1d967cd3348d68343e200c81dcaa4f52e82d56b143212365fea

See more details on using hashes here.

File details

Details for the file simple_ssh_copy-0.1.14-py3-none-any.whl.

File metadata

  • Download URL: simple_ssh_copy-0.1.14-py3-none-any.whl
  • Upload date:
  • Size: 15.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.11.15 Windows/10

File hashes

Hashes for simple_ssh_copy-0.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 99f8f57136ad9ad6001ec46c09539410c7305d0ec54ecb10ea58fb152895eae6
MD5 fd011718c95844705d71b576a5d9d259
BLAKE2b-256 fb1abcb2fb3ef14d9ac56cfca1fc75abc1d320eba8dee72adfeb76b5b0b2206e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page