Termapy Help¶

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

Select a topic:

• Installation — requirements, install with uv or pip
• Demo Mode — try everything without hardware
• Getting Started — connect to real hardware, config files, folder layout
• Configuration — JSON config, field reference, config management
• Custom Buttons — adding toolbar buttons
• Toolbar & Shortcuts — buttons, keyboard shortcuts, command palette
• REPL Commands — full command reference table
• Scripting — automating command sequences
• Protocol Testing — hex send/receive, .pro scripts, CRC, visualizers
• Data Capture — text and binary capture to files
• File Transfer — XMODEM send and receive over serial
• Writing Plugins — add custom commands with Python
• Device Help — integrate your device's commands into termapy
• Using with Git — version control, team workflow, env vars