fusibile
About fusibile ☁️
fusibile is a ready-to-use CLI built on top of
remotefs-fuse that wires a chosen
remotefs backend (SFTP/SCP, FTP, AWS S3, Google
Cloud Storage, SMB, WebDAV, Kube, in-memory, ...) straight into a local mount, via FUSE on
Linux/macOS and Dokany on Windows.
Requirements
-
Linux: you need to have
fuse3installed on your system.Of course, you also need to have the
FUSEkernel module installed. To buildfusibileon Linux, you need to have thelibfuse3development package installed.In Ubuntu, you can install it with:
In CentOS, you can install it with:
-
macOS: you need to have the
macfuseservice installed on your system.You can install it with:
-
Windows: you need to have the
dokanyservice installed on your system.You can install it from https://github.com/dokan-dev/dokany?tab=readme-ov-file#installation
Installation
Features
fusibile can be built with the features below; each feature enables a different file transfer
protocol
aws-s3ftp: FTP and FTPS through the Tokioremotefs-ftpclient (FTPS uses native-tls, vendored on Linux and macOS)gcskubelibfuse: link against the systemlibfuse3on Unix; see theremotefs-fusedocs for what disabling it changessmb: requireslibsmbclienton MacOS and GNU/Linux systemssmb-vendored(UNIX only): build Samba from source instead of linking the systemlibsmbclient, so the resulting binary carries nolibsmbclientdependency. Not enabled by default — it adds well over an hour to a build. The released Linux and macOS binaries are built with it. It has no effect on Windows, where the SMB client isWNetSmbFson the Win32 WNet API and needs no external library at all.ssh(enables both sftp and scp); requireslibssh2on MacOS and GNU/Linux systemswebdav
All the features except smb-vendored are enabled by default; so if you want to build it with
only certain features, pass the --no-default-features option.
fusibile is a Tokio application: every backend implements remotefs's AsyncRemoteFs contract
and is mounted with remotefs-fuse's AsyncMount. The in-memory and SMB clients are adapted with
remotefs::adapters::r#async::Unblock. Ctrl+C, and SIGTERM on Linux and macOS, unmounts and exits
cleanly.
Usage
|||||||
On Windows the mountpoint can be specified simply using the drive letter --to M will mount the
FS to M:\
where protocol options are
- aws-s3
--bucket <name>--region <region>(optional)--endpoint <endpoint_url>(optional)--profile <profile_name>(optional)--access-key <access_key>(optional)--security-token <security_access_token>(optional)--new-path-styleuse new path style
- ftp
--hostname <host>--port <port>(default 21)--username <username>(default:anonymous)--password <password>(optional)--securespecify it if you want to use FTPS--activespecify it if you want to use ACTIVE mode
- gcs
--bucket <name>--endpoint <endpoint_url>(optional; default:https://storage.googleapis.com)--service-account-key <path>path to a service-account JSON file (optional; defaults to application-default credentials)
- kube
--namespace <namespace>(default:default)--cluster-url <url>
- memory: runs a virtual file system in memory
- smb
--address <address>--port <port>(default:139; Linux/Mac only)--share <share_name>--username <username>(optional)--password <password>(optional)--workgroup <workgroup>(optional; Linux/Mac only)--dialect <dialect>(optional; Linux/Mac only; possible values:Auto,Nt1,Smb2,Smb3; default:Auto)
- scp / sftp
--hostname <hostname>--port <port>(optional; falls back to22if not resolved from configuration)--username <username>(optional)--password <password>(optional)--ssh-config <path>(optional; default:~/.ssh/config)
- webdav
--url <url>--username <username>(optional; required--passwordif specified; conflicts with--bearer-token)--password <password>(optional; required--usernameif specified; conflicts with--bearer-token)--bearer-token <token>(optional; conflicts with--usernameand--password)
Other options are:
--uid <uid>: specify the UID to overwrite when mounting the remote fs. See UID and GID override.--gid <gid>: specify the GID to overwrite when mounting the remote fs. See UID and GID override.--default-mode <mode>: set the default file mode to use when the remote fs doesn't support it.
Mount options can be viewed in the docs at https://docs.rs/remotefs-fuse/latest/remotefs-fuse/enum.MountOption.html.
UID and GID override
❗ This doesn't apply to Windows.
The UID and GID overrides make remote entries appear to be owned by local identities. They are useful when, for example:
- your local UID is
1000; - the SFTP account owns remote files as UID
1002; and - local requests from UID
1000would otherwise be checked against UID1002.
Pass the local IDs that should own the mounted entries:
In this example, --uid resolves to 1000, not the remote UID 1002. The
overrides affect ownership presented by the mount and its permission checks;
they do not change ownership on the remote filesystem.
Project stability
Please consider this is an early-stage project and I haven't heavily tested it, in particular the Windows version.
I suggest you to first test it on test filesystems to see whether it behaves correctly with your system.
Contributing and issues 🤝🏻
Contributions, bug reports, new features, and questions are welcome! 😉
If you have any questions or concerns, or you want to suggest a new feature, or you just want to
improve fusibile, feel free to open an issue or a PR on the
remotefs-rs-fuse repository.
Before contributing with AI-assisted tools, please read the AI Policy.
Changelog ⏳
View the changelog.
License 📃
fusibile is licensed under the MIT license.
You can read the entire MIT license.