tcfs Protocol Specification

The full protocol specification is maintained as a LaTeX source file and distributed as PDF.

• Source: docs/tex/protocol.tex
• PDF: Built by CI and available as a release artifact

To build locally:

task docs:pdf
# Output: dist/docs/protocol.pdf

Quick Reference

See the Protocol PDF for full details including:

• .tc file stub format (JSON schema)
• .tcf folder stub format
• S3 chunk layout (content-addressed storage)
• Chunk manifest format
• FastCDC chunking parameters
• Hydration flow
• State tracking schema
• gRPC wire protocol (11 RPCs, including ResolveConflict)
• NATS StateEvent types: FileSynced, FileDeleted, FileRenamed, DeviceOnline, DeviceOffline, ConflictResolved
• NATS subject hierarchy: STATE.{device_id}.{event_type}
• SyncManifest v2 JSON format (with v1 text fallback)