Termapy help¶

Welcome to termapy, a TUI serial terminal with scripting, protocol testing, and data capture.

Termapy TUI

Select a topic:

Installation: requirements, install with uv or pip
Environment & compatibility: OS, terminal emulators, VS Code quirks, KVM/keyboard gotchas
Demo mode: try everything without hardware
Getting started: connect to real hardware, config files, folder layout
Configuration: JSON config, field reference, config management
Serial ports: picking a port, chip info, USB speed, latency tuning
Command-line flags: --ports, --watch, --info, and friends
VT100 mode: raw ANSI passthrough for cursor-addressed devices
Custom buttons: adding toolbar buttons
Toolbar and shortcuts: buttons, keyboard shortcuts, command palette
REPL commands: full command reference table
Variables: $(NAME) expansion, environment and date/time variables, $(*NAME) dereference
Scripting: automating command sequences
Serial tools: /proto.send raw bytes with inline delays, hex mode, the CRC catalog, detection and code generation
Protocol testing: .pro send/expect test scripts, the format-spec language, packet visualizers
Data capture: text and binary capture to files
Symbols: named addresses from your linker map, the /sym commands and the address grammar
Devices: a part's registers from its SVD, the part library, and placing a part on your board (/dev)
Memory: /mem.dump and /mem.write by address or name, the MEM wire spec a device implements
File transfer: XMODEM and YMODEM send and receive over serial
Writing plugins: add custom commands with Python
Device help: integrate your device's commands into termapy
Authoring profiles: write the device profile that powers device help and MCP
MCP server: let an LLM client like Claude drive your device through typed JSON tools
Using with git: version control, team workflow, env vars
On AI assistance: how termapy was built with Claude, and what testing has to do with it
Acknowledgments: the open-source projects and authors termapy depends on