Files
NeoTachyon/docs/knowledge-base/INDEX.md
T

4.5 KiB

Tachyon Knowledge Base & Architecture Index

Welcome to the comprehensive technical knowledge base for Tachyon. This directory contains deep architectural specifications, module references, packet flow maps, and developer guidelines compiled directly from the codebase.


📚 Knowledge Base Table of Contents

Document Description Key Topics Covered
01. System Architecture High-level system architecture & control plane ucode runtime, atomic writes, repository layout, daemon lifecycle
02. ucode Module Reference Comprehensive reference for all 60+ .uc files core/, service/, diagnostics/, singbox/, providers/, nft/, dns/
03. Networking & nftables Packet lifecycle, firewall tables & DNS routing inet TachyonTable, fwmark bitmasks, TProxy, bootstrap DNS loops
04. DPI Bypass Engines Local packet desynchronization deep dive Zapret v1 (nfqws), Zapret v2 (nfqws2), ByeDPI (ciadpi), multisplit, seqovl
05. AI Stack & AI Doctor AI Doctor v2.5, Watchdog & REST Agent API 13 Quick Fixes, Local Rule Doctor, NTP/MTU tuning, OpenAPI 3.0.3, REST API
06. Frontend LuCI Architecture TypeScript SPA & LuCI view integration baseclass.extend patch, reactive stores, live log streaming modal
07. Build & Testing Pipeline Compilation, testing & release workflows build.sh (ipk/apk), install.sh, Docker CI container, vitest tests
08. UCI Configuration Schema Complete /etc/config/tachyon reference All UCI sections, options, validators, default values, ready recipes
09. Telegram Bot Architecture Remote Telegram control daemon protocol Long-polling model, inline keyboards, callback query routing, security
10. Hosts Engine & Blocklists Hosts ingestion, parsing & smart caching combined.txt, multi-format parsing, GitHub mirror retry resiliency
11. Troubleshooting Manual Field diagnostics & emergency recovery Symptom resolution matrix, diagnostic commands, log inspection paths
12. ucode Programming Patterns Developer guidelines for OpenWrt ucode Atomic file writes, shell quoting, libuci bindings, RAM efficiency
13. REST API & MCP Specification REST Agent API & MCP tool definitions OpenAPI 3.0.3, Bearer Auth, OpenAI Function Calling, MCP JSON schema
14. Zapret v2 (nfqws2) Deep Dive Comprehensive Zapret v2 Lua manual Lua desync functions, multisplit, seqovl, wsize, fooling, multi-profiles
15. Zapret v1 (nfqws) Field Guide Complete Zapret v1 CLI specification NFQUEUE desync modes, split-pos, seqovl, syndata, ipfrag, fooling
16. ByeDPI (ciadpi) Reference Complete ByeDPI SOCKS5/TProxy manual Split, disorder, fake, ttl, auto-mode, oob, tlsrec, ip-frag
17. TSPU / DPI Signatures & Counters TSPU filtering mechanics and counters GoogleVideo 4K, Discord WebRTC, TLS 1.3 RST, TTL distance calculation

⚡ Quick Operational Cheat Sheet

Common CLI Commands

# Diagnostics & AI
tachyon doctor                          # Local offline rule diagnostics
tachyon ai_doctor                       # AI Doctor LLM analysis
tachyon apply_quick_fix <code1,code2>   # Apply automated repair codes
tachyon restore_native_internet         # 1-Click emergency WAN restore

# Service & Watchdog
tachyon ai_heal                         # Trigger immediate self-healing cycle
tachyon ai_status                       # Concise Watchdog status JSON
tachyon ai_status_full                  # Full Watchdog telemetry JSON

# Component Management
tachyon check_update <component>        # Check for component updates
tachyon component_action install <comp> # Install or update component

Local Test Execution

# Frontend vitest suite
npm --prefix fe-app-tachyon test

# Full backend suite in Docker CI
docker run --rm -v "$(pwd):/mnt" -w /mnt ucode-ci-img:latest bash tests/run_all.sh