# CipherFS 文档

当前功能、CLI 命令、写入策略、平台边界与已知限制以仓库 README 为准。这里保存目标、设计与证据。中文页以 `.zh.md` 结尾。

| 页面 | 内容 |
| --- | --- |
| [已确认需求](requirements.zh.md) | 目标需求与验收标准 |
| [规模预算](scale-budget.zh.md) | 把规模目标转成可复现实验 |
| [架构](architecture.zh.md) | 分层边界、索引与正文模型、密钥与退休 |
| [架构决策](adr/README.zh.md) | ADR 及其原始背景 |
| [Rust 接入](rust-api.zh.md) | `cipherfs_sync::SyncedVault` 的流式/对象接口与后台同步 |
| [开发](development.zh.md) | 容器内构建、测试和运行 |
| [中继部署](relay-setup.md)（英文） | 自建 iroh 中继 |
| [实现与验证记录](IMPLEMENTATION_AUDIT.md) | 各阶段验证结果、决策和验收表；原始运行在 `evidence/` |
| [待办](TODO.md) | 已知未完成项 |

其他接口：C 头文件 `crates/cipherfs-ffi/cipherfs.h`，Python `crates/cipherfs-python/README.md`，Go `crates/cipherfs-go/README.md`，Web 路由在 `crates/cipherfs-web/src/server.rs`（所有文件、同步与设置接口要求 Bearer 会话）。语言绑定提供本机文件/目录操作、恢复密钥生成和恢复重设密码；同步、设备加入、共享版本和退休通过 Rust、CLI 或 Web 使用。