Documentation / CLI

Run mount-rs from the command line.

The CLI is a top-level way to use mount-rs when you want a ready-made executable workflow instead of embedding the Rust or Node APIs. Probe the host, run the contract against a provider, serve an HTTP edge, or create a real mount when the platform integration is available.

Start with the CLI when you are evaluating the boundary.

The same filesystem contract sits behind the CLI, Rust API, and Node API. Use the CLI to make the storage, transport, lifecycle, and host prerequisites visible before you commit those choices to an application.

Quick start / inspect the host and run a self-test

mount-rs probe
mount-rs sdk-self-test
mount-rs --help

What the CLI is for

mount-rs CLI entry points
Command	Use it to	Mounts?
`probe`	Explain the host's FUSE, 9P, and NFS prerequisites and the auto preference.	No
`sdk-self-test`	Write, read, sync, and optionally reopen through the public filesystem contract.	No
`serve-http`	Expose configured drives through the loopback HTTP service.	No
`mount`	Attach the configured filesystem through the selected native transport.	Yes, where supported

Use a checked-in configuration

Versioned JSON keeps provider and transport choices explicit. Validate the shape first, then run the mount or HTTP service with the same file. Relative paths resolve from the configuration file.

Configuration / validate, mount, or serve

mount-rs validate-config --config config.json
mount-rs mount --config config.json
mount-rs serve-http --config config-http.json

Transport qualification stays host-specific.

The CLI's auto path can select FUSE, 9P, or NFS from the host prerequisites. probe itself never mounts, and serve-http is intentionally unmounted. A passing CLI self-test is not blanket proof of native mount, platform, or production readiness.

Get the verified preview

The current published artifact is a prerelease for aarch64-apple-darwin only. It is a real built CLI archive, but it does not claim a complete platform matrix or native-mount qualification.

Download mount-rs 0.1.0 or read the CLI README and release workflow for the exact build and publication boundary.