Technical Documentation

Comprehensive guides, protocol specifications, configuration manuals, and architecture documentation for BitChat RustPy.

Quickstart & First Run

Launch BitChat from your terminal. If hardware or adapter issues occur, run the diagnostic evaluation to inspect BlueZ, WinRT, and network socket bindings:

Launch BitChat TUI
bitchat
Inspect System & Transports
bitchat --configure

Terminal Slash Commands

BitChat includes an isolated slash command interpreter with strict word boundary token matching. Sentences containing command words are broadcast as normal chat messages.

Command Arguments Description & Behavior
/help none Displays interactive command help overlay with keybindings and usage syntax.
/peers none Lists all discovered active peers, their transport types (BLE/LAN), and RSSI/ping status.
/transport [ble|lan|both] Queries or sets the active physical transport layer.
/channels none Lists joined chat channels and unread message indicators.
/configure none Runs real-time hardware diagnostics against BlueZ, WinRT, and local network socket listeners.
/status none Prints local peer fingerprint, active Noise sessions, and packet routing metrics.
/theme [cyber_cyan|midnight_blue|terminal_emerald] Toggles TUI theme color scheme and persists preference in config.json.
/quit none Gracefully terminates active sessions, scrubs ephemeral RAM keys, and exits cleanly.

Clean Uninstallation Procedures

How to cleanly remove BitChat and optionally scrub all local cryptographic identities.

Standard Uninstallation

Removes application binaries, shortcuts, and start menu entries while preserving your cryptographic identity in ~/.bitchat/identity.json for future reinstallation.

Standard CLI Uninstall
bitchat --uninstall

Complete Scrub (--remove-user-data)

Removes all application binaries AND permanently purges the entire ~/.bitchat/ folder, including identity keys, logs, and configuration files.

Full Purge Uninstall
bitchat --uninstall --remove-user-data