SSHClient

SSHClient is a Go package that provides an easy-to-use interface for executing commands on a remote server via SSH and transferring files using SFTP.

Features

• Execute remote commands via SSH
• Upload and download files via SFTP
• Support for both password and SSH key authentication
• Configurable timeout settings
• Secure host key verification

Installation

go get github.com/vts0/sshclient

Usage

Password Authentication

client, err := sshclient.NewClient("example.com", "user",
    sshclient.WithAuthType(sshclient.PasswordAuth),
    sshclient.WithPassword("securepassword"),
    sshclient.WithPort(22),
    sshclient.WithTimeout(30*time.Second),
    sshclient.WithUseSFTP(true),
)
if err != nil {
    log.Fatalf("Failed to connect: %v", err)
}
defer client.Close()

Key-Based Authentication

client, err := sshclient.NewClient("example.com", "username",
	sshclient.WithAuthType(sshclient.KeyAuth),
	sshclient.WithKeyPath("/home/user/.ssh/id_rsa"),
	sshclient.WithPassphrase("your_passphrase"),
)
if err != nil {
	log.Fatalf("Failed to connect: %v", err)
}
defer client.Close()

Executing Commands

output, err := client.Execute("ls -l")
if err != nil {
    log.Printf("Error executing command: %v", err)
}
fmt.Println("Command output:", output)

File Transfer with SFTP

Uploading a File

err := client.UploadFile(context.Background(), "local.txt", "/remote/path.txt")
if err != nil {
    log.Printf("Upload failed: %v", err)
}

Downloading a File

err := client.DownloadFile(context.Background(), "/remote/file.txt", "local.txt")
if err != nil {
    log.Printf("Download failed: %v", err)
}

License

This project is licensed under the MIT License.