Skip to content

Repository Structure

develicit edited this page Nov 16, 2026 · 2 revisions

Repository Structure

The root Cargo.toml defines a Rust workspace containing 12 product crates. vendor/* is excluded from workspace membership and connected through local dependency patches.

Directory map

clipsync/
├── Cargo.toml / Cargo.lock       Product workspace and lockfile
├── crates/                      Shared libraries and executables
├── docs/                        Detailed protocol, security, testing, and operations references
├── scripts/                     Validation, packaging, installation, and operations tools
│   └── tests/                   Tests for the Python tools
├── fuzz/                        Separate manifest, lockfile, and fuzz targets
├── vendor/                      Compatibility patches with recorded provenance and scope
├── packaging/                   Platform distribution and packaging resources
├── deploy/                      Self-hosting configuration
└── .github/workflows/            CI, security, coverage, and release automation

Crate responsibilities

The dependency column lists project crates declared in each manifest's ordinary dependencies section. External libraries and test-only dependencies are omitted.

Crate Responsibility Direct internal dependencies (clipsync- omitted)
clipsync-protocol IDs, JSON control messages, binary frames, and limits None
clipsync-crypto SPAKE2, key derivation, AES-GCM, Noise, and device keys protocol
clipsync-storage Local paths, configuration, room/device records, and secrets crypto, protocol
clipsync-clipboard Shared text/image/file model and OS adapters protocol
clipsync-transport HTTP/WebSocket clients and TLS verification protocol
clipsync-transfer Chunking, reassembly, manifest validation, and safe received-file storage crypto, protocol
clipsync-daemon Per-user service installation/removal, PID management, and local IPC protocol, storage
clipsync-core App API, pairing, synchronization, and loop suppression clipboard, crypto, daemon, protocol, storage, transfer, transport
clipsync-cli clipsync argument parsing and output clipboard, core, daemon, protocol, storage
clipsync-desktop egui/eframe desktop window core, daemon, storage
clipsync-mobile UniFFI API and host clipboard integration clipboard, core, protocol, storage
clipsync-relay Axum HTTP/WS server and routing protocol

Where to start for a change

Task Files to inspect first
Command arguments and output crates/clipsync-cli/src/cli.rs, main.rs, output.rs
Pairing failures and timeouts crates/clipsync-core/src/pairing.rs, crates/clipsync-relay/src/state.rs, ws.rs
Sync, reconnection, and repeated transfers crates/clipsync-core/src/engine.rs, loop_guard.rs
Wire formats and size limits crates/clipsync-protocol/src/messages.rs, chunk.rs, limits.rs
Cryptographic compatibility crates/clipsync-crypto/src/, crates/clipsync-crypto/tests/wire_contract.rs
File paths and received-transfer assembly crates/clipsync-transfer/src/ and its tests/ directory
Credentials and migrations crates/clipsync-storage/src/secrets.rs, store.rs, config.rs
OS clipboard behavior crates/clipsync-clipboard/src/
Services and IPC crates/clipsync-daemon/src/service.rs, ipc.rs
Mobile bridge crates/clipsync-mobile/src/lib.rs, docs/mobile.md
Relay TLS and webhooks crates/clipsync-relay/src/transport.rs, webhook.rs

Separate dependency graphs and repositories

fuzz/ has its own Cargo manifest and lockfile. Product dependency changes also require checking compatibility with the fuzz graph. Local patches under vendor/ record the original source, hashes, change scope, and retirement criteria, with dedicated checks for that evidence.

The iOS and Android applications are not directories in this repository. Their native UIs live in the iOS repository and Android repository, using bindings and libraries generated from clipsync-mobile.

Sources: workspace manifest, all crates, vendor maintenance policy, and dependency update record.

Clone this wiki locally