Async SSH library for Rust

SSH made simple.

A lightweight, asynchronous Rust library for SSH operations. Execute remote commands, transfer files via SCP, and manage interactive PTY sessions with an ergonomic builder API. Built on tokio and russh.

Get Started View Examples

use simple_ssh::Session;
use anyhow::Result;
// Execute remote commands with the builder API
async fn main() -> Result<()> {
    let session = Session::init()
        .with_host("192.168.1.100")
        .with_user("admin")
        .with_passwd("secret")
        .with_port(2222)
        .build()?;
    let mut ssh = session.connect().await?;
    // Run a command and get exit code
    let code = ssh.cmd("uname -a").await?;
    println!("Exit code: {}", code);
    Ok(())
}

master* Rust

Ln 7, Col 9 UTF-8 LF

use simple_ssh::Session;
use anyhow::Result;
// Transfer files securely via SCP
async fn main() -> Result<()> {
    let session = Session::init()
        .with_host("server.example.com")
        .with_user("deploy")
        .with_key("~/.ssh/id_rsa".into())
        .build()?;
    let mut ssh = session.connect().await?;
    // Upload local file to remote
    ssh.scp("./target/release/app", "/usr/local/bin/app").await?;
    Ok(())
}

master* Rust

Ln 12, Col 5 UTF-8 LF

use simple_ssh::Session;
use anyhow::Result;
// Interactive PTY session with raw mode
async fn main() -> Result<()> {
    let session = Session::init()
        .with_host("server.local")
        .with_user("admin")
        .with_key("~/.ssh/id_ed25519".into())
        .build()?;
    let mut ssh = session.connect().await?;
    // Interactive shell with raw mode and auto-resize
    let exit_code = ssh
        .pty_builder()
        .with_raw()
        .with_term("xterm-256color")
        .with_auto_resize()
        .run()
        .await?;
    Ok(())
}

master* Rust

Ln 16, Col 9 UTF-8 LF

use simple_ssh::Session;
use anyhow::Result;
// Connect to IPv6 link-local address with scope ID
async fn main() -> Result<()> {
    let session = Session::init()
        .with_host("fe80::1")
        .with_scope("eth0") // Network interface
        .with_user("pi")
        .with_passwd("raspberry")
        .build()?;
    let mut ssh = session.connect().await?;
    Ok(())
}

master* Rust

Ln 8, Col 19 UTF-8 LF

Features

Everything you need for SSH in Rust.

A complete toolkit for SSH operations with an ergonomic builder API designed for async Rust.

Async by Design

Built on tokio and russh for truly non-blocking SSH operations. Execute multiple commands concurrently without blocking your runtime.

SCP File Transfers

Upload and download files securely with the same async API. Minimal code, maximum reliability for your file transfer needs.

Interactive PTY

Full terminal sessions with raw mode support, auto-resize, and mode detection for alt-buffer apps like vim and nano.

IPv6 Link-Local

Full IPv6 support including link-local addresses with scope ID. Connect to devices on your local network without DNS configuration.

Flexible Auth

Password, key-based, certificate, and no-auth methods. simple_ssh automatically selects the right authentication based on your configuration.

CLI Tools Included

Ready-to-use simple-ssh and simple-scp binaries. Terminal multiplexer support with 1x2, 2x1, and 2x2 layouts for managing multiple sessions.

Examples

Copy, paste, run.

Practical examples for common SSH operations.

Cargo.toml

# Add to your Cargo.toml
[dependencies]
simple_ssh = { git = "https://github.com/juliankahlert/simple_ssh" }
tokio = { version = "1", features = ["full"] }
anyhow = "1"

Programmatic PTY for TUIs

// Embed SSH in your TUI application
let mut handle = ssh
    .pty_builder()
    .with_term("xterm-256color")
    .with_size(80, 24)
    .open()
    .await?;

// Send input programmatically
handle.write(b"ls -la\n").await?;

// Read output
while let Some(data) = handle.read().await {
    println!("Received: {:?}", data);
}

SSH made simple.

Everything you need for SSH in Rust.

Async by Design

SCP File Transfers

Interactive PTY

IPv6 Link-Local

Flexible Auth

CLI Tools Included

Copy, paste, run.

Add it to your project.