10 releases (breaking)

0.8.1 Mar 13, 2023
0.7.0 Dec 12, 2021
0.6.0 Nov 23, 2021
0.4.0 Apr 30, 2021
0.1.0 May 20, 2019

#67 in Hardware support

Download history 3045/week @ 2024-08-01 2396/week @ 2024-08-08 2175/week @ 2024-08-15 2738/week @ 2024-08-22 12888/week @ 2024-08-29 21910/week @ 2024-09-05 27666/week @ 2024-09-12 28965/week @ 2024-09-19 29972/week @ 2024-09-26 4678/week @ 2024-10-03 4021/week @ 2024-10-10 4032/week @ 2024-10-17 3982/week @ 2024-10-24 4418/week @ 2024-10-31 3271/week @ 2024-11-07 2505/week @ 2024-11-14

14,865 downloads per month
Used in 39 crates (18 directly)

MIT license

130KB
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.1–3MB
~61K SLoC