Quick Start

The fastest way to try BrewFS is the LocalFS + SQLite combination: file data is stored as object blocks on the local disk, and metadata lives in a single SQLite file — no external services required.

Mount

mkdir -p /tmp/brewfs-mnt /tmp/brewfs-data

cargo run -p brewfs -- mount /tmp/brewfs-mnt \
  --data-backend local-fs \
  --data-dir     /tmp/brewfs-data \
  --meta-backend sqlx \
  --meta-url     sqlite:///tmp/brewfs-meta.db

Try file operations

echo "hello brewfs" > /tmp/brewfs-mnt/hello.txt
cat /tmp/brewfs-mnt/hello.txt
ls -lh /tmp/brewfs-mnt

What just happened

• The mount point (/tmp/brewfs-mnt) exposes a POSIX-like namespace over FUSE.
• File data is split into Chunk / Block / Slice and stored under /tmp/brewfs-data.
• Namespace, inode, and slice metadata are committed to sqlite:///tmp/brewfs-meta.db.

Continue with Installation or move on to Mount BrewFS for S3 + Redis setups.