Repository navigation
Home
Your Name edited this page Aug 26, 2026
·
3 revisions
Welcome to the official Tincan CLI Technical Wiki. Tincan is a serverless, peer-to-peer (P2P) voice and text chat client engineered for the terminal. It delivers multi-channel group communication without requiring central servers, user accounts, or third-party infrastructure.
-
- Executive Architecture & Philosophy
- Dual-Plane Design: Control Plane (Star) vs Voice Plane (Mesh)
- Coordinator State Machine & Roster Synchronization
- Bandwidth Scaling & Performance Profile
-
- Audio Pipeline & Signal Flow Diagram
-
cpalAudio Host Driver Bridge - Lock-Free Ring Buffers (
rtrb) - Opus Codec & Packet Loss Concealment (PLC)
- Voice Activity Detection (VAD) & DTX Silence Suppression
- Per-Peer Adaptive Jitter Buffer
- Multi-Source PCM Audio Mixer & Soft Limiter
-
- Two-Tier Security Architecture
- Zero-Knowledge Challenge-Response Authentication (Argon2id + Nonce)
- Transport Layer Encryption: QUIC TLS 1.3 + Ed25519 Public Keys (Iroh)
- Comprehensive Threat Model & Mitigations
-
- Binary Wire Formats (
src/proto.rs) - Control Plane Messages (
ClientMessage,ServerMessage) - Voice Datagram Packet Header & Payload Layout
- Postcard Binary Serialization Standard
- Binary Wire Formats (
-
Developer & Contribution Guide
- Development Setup & Dependencies (Opus, ALSA/CoreAudio)
- Codebase Directory & Module Map
- Running the Non-Networked Integration Test Suite (94 Tests)
- Debug Logging & Inspection
-
- macOS (Apple Silicon & Intel)
- Linux (Debian, Ubuntu, Fedora, Arch)
- Windows & WASAPI Driver Strategy
- Mobile & Embedded (Termux Android, Raspberry Pi)
-
- Audio Hardware & 48 kHz Sample Rate Setup
- NAT Traversal & DERP Relays
- Terminal Hotkey Configuration & Troubleshooting
-
Git Branching & Release Strategy
- Git Flow / GitHub Flow Hybrid Model
- Branch Hierarchy (
main,develop,feature/*,fix/*) - PR Review & Automated Release Workflow
- Main Repository: github.com/bilalyazicioglu/tincan-cli
- Contributing Guidelines: CONTRIBUTING.md
- Issue Tracker: GitHub Issues