CipherFS documentation
The repository README describes current behavior and is authoritative for CLI commands, write policies, platform scope and known limits. These pages hold the target, the design and the evidence. Chinese versions carry a .zh.md suffix.
| Page | Content |
|---|---|
| Requirements (Chinese) | Confirmed target requirements and acceptance criteria |
| Scale budget (Chinese) | How the scale targets are turned into reproducible experiments |
| Architecture | Layer boundaries, index and content model, keys and retirement |
| Architecture decisions | ADR records with their original context |
| Rust integration | cipherfs_sync::SyncedVault: streaming and object operations, background sync |
| Development | Containerized build, test and run |
| Relay setup | Running a self-hosted iroh relay for P2P sync |
| Implementation record (Chinese) | Per-stage verification results, decisions and the acceptance matrix; raw runs under evidence/ |
| TODO (Chinese) | Known unfinished work |
Other interfaces: C header crates/cipherfs-ffi/cipherfs.h, Python crates/cipherfs-python/README.md, Go crates/cipherfs-go/README.md, Web routes in crates/cipherfs-web/src/server.rs (every file, sync and settings route requires a Bearer session). The language bindings cover local file and directory operations, recovery-key creation and recovery password reset; synchronization, enrollment, shared versions and retirement use Rust, the CLI or Web.