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:
bitchat
bitchat --configure
Installation & Platform Guides
System prerequisites, setup procedures, and platform integration.
Architecture & Rust Engine
Core design, native PyO3 integration, and component boundaries.
- System Architecture & Rust Migration Assessment ARCHITECTURE.md →
- Development Guide (Cargo, Maturin, Ruff, Pyright) DEVELOPMENT.md →
- Repository Documentation Directory Index INDEX.md →
- v0.3.4 Rust Migration, Performance & Security Impact Report V0.3.4-RUST-MIGRATION...md →
- Phase 3 Implementation & Verification Report (v0.3.4) PHASE-3-REPORT.md →
- v0.3.4 Production GitHub Release Notes & Checksums releases/tag/v0.3.4 →
- Development Roadmap & 7-Stage Rust Migration ROADMAP.md →
Protocol & Wire Format
BitChat v1 protocol framing, store-and-forward mesh routing, and MTU limits.
Security, Crypto & Storage
Cryptographic foundations, Noise XX specification, and local filesystem data.
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.
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.
bitchat --uninstall --remove-user-data