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 fuse3 installed on your system.

  Of course, you also need to have the FUSE kernel module installed. To build fusibile on Linux, you need to have the libfuse3 development package installed.

  In Ubuntu, you can install it with:

  sudo apt-get install fuse3 libfuse3-dev
  

  In CentOS, you can install it with:

  sudo yum install fuse-devel
  

• macOS: you need to have the macfuse service installed on your system.

  You can install it with:

  brew install macfuse
  

• Windows: you need to have the dokany service installed on your system.

  You can install it from https://github.com/dokan-dev/dokany?tab=readme-ov-file#installation

Installation

cargo install fusibile

Features

fusibile can be built with the features below; each feature enables a different file transfer protocol

• aws-s3
• ftp
• gcs
• kube
• libfuse: link against the system libfuse3 on Unix; see the remotefs-fuse docs for what disabling it changes
• smb: requires libsmbclient on MacOS and GNU/Linux systems
• smb-vendored (UNIX only): build Samba from source instead of linking the system libsmbclient, so the resulting binary carries no libsmbclient dependency. 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 is WNetSmbFs on the Win32 WNet API and needs no external library at all.
• ssh (enables both sftp and scp); requires libssh2 on MacOS and GNU/Linux systems
• webdav

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.

Usage

fusibile -o opt1 -o opt2=abc --to /mnt/to --volume <volume-name> <aws-s3|ftp|gcs|kube|smb|scp|sftp|webdav> [protocol-options...]

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-style use new path style
• ftp
  • --hostname <host>
  • --port <port> (default 21)
  • --username <username> (default: anonymous)
  • --password <password> (optional)
  • --secure specify it if you want to use FTPS
  • --active specify 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> (default 22)
  • --username <username>
  • --password <password>
  • --ssh-config <path> (optional; default: ~/.ssh/config)
• webdav
  • --url <url>
  • --username <username> (optional; required --password if specified; conflicts with --bearer-token)
  • --password <password> (optional; required --username if specified; conflicts with --bearer-token)
  • --bearer-token <token> (optional; conflicts with --username and --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 possibility to override UID and GID is used because sometimes this scenario can happen:

1. my UID is 1000
2. I'm mounting for instance a SFTP file system and the remote user I used to sign in has UID 1002
3. I'm unable to operate on the file system because UID 1000 can't operate to files owned by 1002

But of course this doesn't make sense: I signed in with user who owns those files, so I should be able to operate on them. That's why the Uid and Gid options exist.

Setting the --uid option to 1002 you'll be able to operate on the File system as it should.

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.

Support the developer ☕

If you like fusibile and you're grateful for the work I've done, please consider a little donation 🥳

You can make a donation with one of these platforms:

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.