Getting Started
CLI Reference
The brewfs command-line interface.
Commands
brewfs mount [OPTIONS] [MOUNT_POINT] # mount the filesystem
brewfs info [MOUNT_POINT] # inspect a running mount
brewfs gc [MOUNT_POINT] [--dry-run] # run orphan-object GC
brewfs console [OPTIONS] # run the BrewFS web consoleCommon mount options
--data-backend <local-fs|s3> # object block storage
--data-dir <path> # LocalFS data directory
--s3-bucket <bucket> # S3-compatible bucket
--s3-endpoint <url> # RustFS, MinIO, Ceph RGW, or another S3 endpoint
--meta-backend <sqlx|redis|etcd|tikv>
--meta-url <url> # e.g. sqlite:///tmp/meta.db, redis://…Runtime metrics are exposed through the read-only .stats file at the mount root. Use
cat /mnt/brewfs/.stats for Prometheus text or build brewfs-stats for a live terminal
view. Run brewfs --help and brewfs <COMMAND> --help for the current option list.