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 and 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
• On AI assistance: how termapy was built with Claude, and what testing has to do with it