sshtransfer

sshtransfer

Efficient file transfer over SSH for Go. Download and upload files in batches through a single SSH tunnel with automatic retry logic.

Features

• 🚀 Batch transfers - multiple files through one SSH connection
• 🔄 Auto-retry - automatic reconnection on network failures
• 🗜️ Compression - on-the-fly data compression
• 📊 Progress tracking - real-time transfer statistics
• 🔀 Two modes - rsync (resumable) or tar (faster for small files)
• 🔐 Secure - uses your existing SSH keys
• ⚡ Connection reuse - SSH ControlMaster for efficiency

Installation

go get github.com/AslanKarimov46/sshtransfer

Quick Start

package main

import (
    "context"
    "log"
    
    "github.com/AslanKarimov46/sshtransfer"
)

func main() {
    client := sshtransfer.New("user@server.com",
        sshtransfer.WithRemoteBase("/data/files/"),
        sshtransfer.WithLocalBase("./downloads/"),
    )
    defer client.Close()

    ctx := context.Background()

    // Check connection
    if err := client.Ping(ctx); err != nil {
        log.Fatal("Cannot connect:", err)
    }

    // Download single file
    if err := client.Download(ctx, "document.pdf"); err != nil {
        log.Fatal(err)
    }
    
    log.Println("Downloaded successfully!")
}

Batch Transfer

Transfer multiple files efficiently through a single SSH connection:

files := []string{
    "recordings/2024-01-01/audio1.mp3",
    "recordings/2024-01-01/audio2.mp3",
    "recordings/2024-01-02/audio3.mp3",
}

result, err := client.DownloadBatch(ctx, files)
if err != nil {
    log.Fatal(err)
}

log.Printf("✓ Downloaded %d files in %v", result.Success, result.Duration)

Auto-Retry

Configure automatic retry on connection failures:

client := sshtransfer.New("user@server.com",
    sshtransfer.WithRetryAttempts(5),     // retry up to 5 times
    sshtransfer.WithRetryDelay(3*time.Second), // wait 3s between retries
)

Progress Tracking

result, err := client.DownloadBatch(ctx, files,
    sshtransfer.WithProgress(func(p sshtransfer.Progress) {
        fmt.Printf("\r[%3.0f%%] %d/%d files | %s | %s | ETA: %v",
            p.Percent(),
            p.FilesDone,
            p.FilesTotal,
            p.BytesHuman(),
            p.SpeedHuman(),
            p.ETA(),
        )
    }),
)

Upload Files

// Single file
err := client.Upload(ctx, "local/report.pdf", "remote/reports/report.pdf")

// Batch upload
result, err := client.UploadBatch(ctx, []string{
    "file1.txt",
    "file2.txt",
})

Delete Remote Files

// Delete single file
err := client.Delete(ctx, "old-file.txt")

// Delete multiple files
err := client.DeleteBatch(ctx, []string{"file1.txt", "file2.txt"})

Transfer Modes

// rsync mode (default) - supports resume, good for large files
client := sshtransfer.New(host, sshtransfer.WithMode(sshtransfer.ModeRsync))

// tar mode - faster for many small files
client := sshtransfer.New(host, sshtransfer.WithMode(sshtransfer.ModeTar))

API Reference

Client Methods

Configuration Options

Requirements

• Go 1.21+
• rsync installed on both local and remote (for ModeRsync)
• tar installed on both sides (for ModeTar)
• SSH key-based authentication configured

Performance

Comparison for transferring 100 files (50MB total) over 1Gbit network:

Examples

See the examples directory:

• basic - Simple download/upload
• batch - Batch operations
• progress - Progress tracking

Contributing

Contributions are welcome! Please read CONTRIBUTING.md first.

License

MIT License - see LICENSE for details.