Baudrun documentation¶

Reference material for Baudrun's advanced features and customization systems. For the product-level description, screenshots, and install instructions see the top-level README.

Install & build¶

Requirements — minimum OS versions to run a released build, plus the toolchain needed to build from source. Running and building details are in separate sections.

Hardware¶

USB-serial adapters — which chipsets work on which OS, which path picks them up (OS kernel module, Apple DEXT, vendor driver, or Baudrun's libusb-direct backend), and a short buying guide for cables that work everywhere. Covers the vendor- rebrand cases (Siemens RUGGEDCOM, counterfeit-flagged Prolific) and the specific VID:PID values Apple's bundled DEXTs cover.

Feature reference¶

Advanced features — every feature beyond basic connect-and-type, documented as reference. Send Break, hex send and hex view, control-line policies (DTR/RTS), session logging, auto- reconnect, paste safety, suspend/resume, multi-window with live session migration, signed software updates, syntax highlighting + rule packs + the browser-based playground, theme preview, light/ dark appearance, and the USB-serial driver-detection banner.

Keyboard shortcuts — default bindings for zoom, Clear, Send Break, and Suspend. Session shortcuts are user-editable via Settings; the scheme differs per-OS so plain Ctrl-letter presses still reach the serial device on Linux and Windows.

Customization¶

Profiles — serial-connection settings. Full JSON schema, valid values for every enum field, four worked examples (network switch, USB-C console, Arduino, Modbus RTU debug), and recipes for bulk-generating profiles.json from CSV inventory via jq or Python.

Themes — terminal-viewport color schemes. JSON schema with the 16 ANSI slots plus cursor/selection/background fields, how the highlighter maps to ANSI slots, .itermcolors import workflow, pointers to the iterm2colorschemes / mbadolato / Gogh ecosystems, and tips on picking a theme that reads well on real network-gear output.

Accessibility — xterm screen-reader mode, prefers-reduced-motion support, Cmd/Ctrl +/- zoom, ARIA-label coverage, and the known caveats (WKWebView media-query caching, gaps that are still on the TODO).

Skins — app-chrome swaps. Complete CSS-variable reference grouped by purpose (typography, surfaces, foreground, borders, semantic colors, radii/elevation, layout, scrollbars, overlay), light/dark handling caveats given the pinned-dark window vibrancy on macOS, explicit list of what skins can and can't reach, a minimal Ocean skin example, and dev tips for iterating with DevTools.

Project¶

CHANGELOG — notable user-facing changes per release. Reads as the curated complement to GitHub's per-commit "What's Changed" lists.

TODO — roadmap. Items tagged [on request] are features that would be implemented if someone asks for them (macros, keyboard-shortcut scheme for Break / Clear / Suspend, ZMODEM file transfer). Everything else is either done or in the active backlog.

Baudrun is developed in spare time. If it saves you from the screen /dev/cu.usbserial-… / baud-rate-lookup / three-terminal-apps dance, you can support further work via GitHub Sponsors: