Cross-platform PTY (pseudo-terminal) spawning for MoonBit native targets, integrated with moonbitlang/async.

pty

pseudo-terminal

async

native

moon add moonbit-community/pty@0.4.0

Download zip

Author

moonbit-community

Version

0.4.0

License

Apache-2.0

Repository

github.com/moonbit-community/tonyfettes-pty

Last updated

2 days ago

Downloads

Dependencies

moonbitlang/async0.20.5

README

#moonbit-community/pty

Cross-platform PTY (pseudo-terminal) spawning for MoonBit native targets, integrated with moonbitlang/async so reads and writes go through the async event loop instead of blocking the thread.

#API

@async.with_task_group(group => {
  let pty = @pty.spawn(
    group,
    "sh", ["-c", "echo hello"],
    rows=24, cols=80,
    cwd="/workspace",
  )
  let text = pty.read_all().text()  // Pty implements @io.Reader
  pty.write(b"ls\n")                // ... and @io.Writer
  pty.resize(rows=40, cols=120)
  let pid : Int = pty.pid()
  let exit_code : Int = pty.wait()
})

The pty's resources are released when the task group exits. On cancellation the child gets a 5 s grace period, then a hard kill. Pty::wait returns the child's exit code; call it explicitly when the exit code matters.

#Drain the pty concurrently

Do not wait() first and read() afterwards. A pty master is a bounded kernel queue, and on macOS the kernel discards whatever is still queued a few hundred milliseconds after the child exits. Read concurrently while waiting; reading late yields a clean but empty EOF.

Relatedly, ConPTY output is a screen rendering, not a byte stream: expect VT escape sequences (including an initial clear-screen) surrounding your child's output. Strip or escape them before asserting on pty output in tests — a failing diff that prints raw pty output replays those sequences into your terminal.

#Further reading

docs/internals.md — executable resolution, environment merging, and platform architecture: unix fork/execve, Windows ConPTY startup, argv encoding.
docs/invariants.md — hard-won debugging conclusions and decision records that must not regress.

pty

#moonbit-community/pty

#API

#Drain the pty concurrently

#Further reading

#Pty

#Pty::_direct_read

#Pty::_get_internal_buffer

#Pty::drop

#Pty::pid

#Pty::read

#Pty::read_all

#Pty::read_exactly

#Pty::read_some

#Pty::read_until

#Pty::resize

#Pty::wait

#Pty::write

#Pty::write_once

#Pty::write_reader

#spawn

Source Files

#
Pty

#
Pty::_direct_read

#
Pty::_get_internal_buffer

#
Pty::drop

#
Pty::pid

#
Pty::read

#
Pty::read_all

#
Pty::read_exactly

#
Pty::read_some

#
Pty::read_until

#
Pty::resize

#
Pty::wait

#
Pty::write

#
Pty::write_once

#
Pty::write_reader

#
spawn