Documentation / start here

Choose the file decision you need to make.

Move from the first file feature to a deliberate storage and transport design. These pages show the contract, the provider roles, the edge choices, and the evidence behind the promise.

Start with the smallest working boundary

Start with the CLI when you want to run mount-rs as an executable. Choose Rust or Node when you are embedding the contract. Then choose the metadata and immutable block roles, create a real FUSE, NFS, 9P, or FSKit mount—or choose HTTP/WebDAV at the edge—and read the acceptance requirements before making a production claim.

Four decisions, one observable contract

The contract behind the product

Core
FsDriver / FileHandle

Paths, handles, stats, directory operations, and explicit sync behavior.

Storage
MetadataStore + BlockStore

Namespace publication and immutable bytes are independent contracts.

Edge
Transports and bindings

FUSE, NFS, 9P, WebDAV, S3, auto-mount, CLI, and napi-rs are integration surfaces.

A file is two planes

Publish references only after the bytes are ready.

The provider model keeps metadata and immutable blocks independent: write fixed-size chunks, complete the block-store barrier, then publish a metadata revision with a revision CAS and writer fence. Complete the metadata barrier before acknowledging the write.

Metadatainode → entries → block refs
Blockschunk → immutable key → bytes
Publishlease → fence → revision

Choose your starting point

The project is prerelease. Examples point to real exported types and repository paths, but a working example is not proof that every backend, platform, journal mode, or failure scenario has passed the full acceptance suite. The overall project is in progress and is not release-ready.

GitHub Release · Preview

mount-rs 0.2.0

The repository's only CLI target, built in release mode and published as a GitHub prerelease. This artifact is platform-specific and does not imply a complete release matrix or native-mount qualification.

Targetaarch64-apple-darwin
Artifactmount-rs-0.2.0-aarch64-apple-darwin.tar.gz
SHA-2561d6100c0eb5c167f98c8219210fc9f0f8ffc2f882b2b1cbac5395eab3eaf3036
View downloadsGitHub Release + checksum manifest

Read the source alongside this guide: architecture, porting evidence, requirements, and work tracker.