OK serial terminal   🔌〡〇〡〇〡💻

An interactive serial port terminal, built on ok-serial.

Think twice before using this! Consider something more established:

• tio - not Python, but a great serial terminal utility
• picocom - the classic minimal serial terminal
• screen - the terminal multiplexer is also a serial terminal
• minicom - if you're nostalgic for the DOS era
• pyserial's miniterm - already installed if you have pyserial

Installation and Usage

Install the Python package to get the okterm utility:

pip install ok-serial-terminal
# or 'uv add ok-serial-terminal', 'uv tool install ok-serial-terminal', etc.
okterm <port> [baud]

OR, skip the package install and run it directly with uvx or pipx:

uvx ok-serial-terminal <port> [baud]
# or `pipx run ok-serial-terminal <port> [baud]`

The baud rate defaults to 115200 if omitted. The port is an ok-serial match expression, so okterm RP2040, okterm 2e8a:0005, and okterm /dev/ttyACM0 all work. Run okserial (or uvx ok-serial, etc.) to list visible ports and their attributes.

On a terminal (unless --plain is given), okterm decorates the display with connection status, control signal state, and an indicator for unechoed typed characters. In this mode, ctrl-] opens a menu and ctrl-\ quits.

In plain mode (I/O redirected or --plain given), data is pass-through and ctrl-C quits.

See okterm --help for more options (locking mode, etc).