Skip to content

remotefs-rs/remotefs-rs-ssh

Repository files navigation

remotefs SSH

Changelog · Get started · Documentation

~ Remotefs SSH client ~

Developed by @veeso

Current version: 0.5.0 (26/10/2024)

License-MIT Repo stars Downloads counter Latest version Ko-fi

Linux CI MacOS CI Windows CI Coveralls Docs


About remotefs-ssh ☁️

remotefs-ssh is a client implementation for remotefs, providing support for the SFTP/SCP protocol.


Get started 🚀

First of all, add remotefs-ssh to your project dependencies:

remotefs = "0.3"
remotefs-ssh = "^0.5"

these features are supported:

  • find: enable find() method on client (enabled by default)
  • no-log: disable logging. By default, this library will log via the log crate.
  • ssh2-vendored: build with static libssl

Client compatibility table ✔️

The following table states the compatibility for the client client and the remote file system trait method.

Note: connect(), disconnect() and is_connected() MUST always be supported, and are so omitted in the table.

Client/Method Scp Sftp
append_file No Yes
append No Yes
change_dir Yes Yes
copy Yes Yes
create_dir Yes Yes
create_file Yes Yes
create Yes Yes
exec Yes Yes
exists Yes Yes
list_dir Yes Yes
mov Yes Yes
open_file Yes Yes
open Yes Yes
pwd Yes Yes
remove_dir_all Yes Yes
remove_dir Yes Yes
remove_file Yes Yes
setstat Yes Yes
stat Yes Yes
symlink Yes Yes

Support the developer ☕

If you like remotefs-ssh 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:

ko-fi PayPal bitcoin


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 want just want to improve remotefs, feel free to open an issue or a PR.

Please follow our contributing guidelines


Changelog ⏳

View remotefs' changelog HERE


Powered by 💪

remotefs-ssh is powered by these aweseome projects:


License 📃

remotefs-ssh is licensed under the MIT license.

You can read the entire license HERE