11 releases (breaking)

0.9.0 Feb 11, 2025
0.8.1 Mar 13, 2023
0.8.0 Feb 17, 2023
0.7.0 Dec 12, 2021
0.1.0 May 20, 2019

#203 in Hardware support

Download history 4844/week @ 2025-01-30 5128/week @ 2025-02-06 5623/week @ 2025-02-13 7185/week @ 2025-02-20 6838/week @ 2025-02-27 7764/week @ 2025-03-06 5832/week @ 2025-03-13 5956/week @ 2025-03-20 6131/week @ 2025-03-27 7042/week @ 2025-04-03 6243/week @ 2025-04-10 5408/week @ 2025-04-17 8368/week @ 2025-04-24 9423/week @ 2025-05-01 10355/week @ 2025-05-08 7882/week @ 2025-05-15

36,937 downloads per month
Used in 53 crates (23 directly)

MIT license

135KB
3K SLoC

This crate provides a cross platform API for working with the psuedo terminal (pty) interfaces provided by the system. Unlike other crates in this space, this crate provides a set of traits that allow selecting from different implementations at runtime. This crate is part of wezterm.

use portable_pty::{CommandBuilder, PtySize, native_pty_system, PtySystem};
use anyhow::Error;

// Use the native pty implementation for the system
let pty_system = native_pty_system();

// Create a new pty
let mut pair = pty_system.openpty(PtySize {
    rows: 24,
    cols: 80,
    // Not all systems support pixel_width, pixel_height,
    // but it is good practice to set it to something
    // that matches the size of the selected font.  That
    // is more complex than can be shown here in this
    // brief example though!
    pixel_width: 0,
    pixel_height: 0,
})?;

// Spawn a shell into the pty
let cmd = CommandBuilder::new("bash");
let child = pair.slave.spawn_command(cmd)?;

// Read and parse output from the pty with reader
let mut reader = pair.master.try_clone_reader()?;

// Send data to the pty by writing to the master
writeln!(pair.master.take_writer()?, "ls -l\r\n")?;

Dependencies

~2.2–3MB
~63K SLoC