Skip to content
Your Name edited this page Aug 26, 2026 · 3 revisions

Tincan CLI Wiki & Technical Documentation Portal

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.


πŸ“š Wiki Contents

  1. Architecture Overview

    • Executive Architecture & Philosophy
    • Dual-Plane Design: Control Plane (Star) vs Voice Plane (Mesh)
    • Coordinator State Machine & Roster Synchronization
    • Bandwidth Scaling & Performance Profile
  2. Audio Engine Deep Dive

    • Audio Pipeline & Signal Flow Diagram
    • cpal Audio 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
  3. Security & Cryptography Model

    • 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
  4. Wire Protocol Specification

    • Binary Wire Formats (src/proto.rs)
    • Control Plane Messages (ClientMessage, ServerMessage)
    • Voice Datagram Packet Header & Payload Layout
    • Postcard Binary Serialization Standard
  5. 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
  6. Platform & OS Compatibility

    • macOS (Apple Silicon & Intel)
    • Linux (Debian, Ubuntu, Fedora, Arch)
    • Windows & WASAPI Driver Strategy
    • Mobile & Embedded (Termux Android, Raspberry Pi)
  7. Troubleshooting & FAQ

    • Audio Hardware & 48 kHz Sample Rate Setup
    • NAT Traversal & DERP Relays
    • Terminal Hotkey Configuration & Troubleshooting
  8. Git Branching & Release Strategy

    • Git Flow / GitHub Flow Hybrid Model
    • Branch Hierarchy (main, develop, feature/*, fix/*)
    • PR Review & Automated Release Workflow

⚑ Quick Navigation