Skip to content

hansipie/RustyFTP

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RustyFTP

Rust License Platform

A modern, feature-rich FTP/SFTP command-line client written in Rust.

RustyFTP is a powerful terminal-based file transfer client designed for developers and power users. It combines the speed and safety of Rust with a modern, user-friendly interface featuring auto-completion, background transfers, and robust error handling.

⚠️ Disclaimer: This project is a study case and educational project developed with AI assistance. It demonstrates Rust programming concepts, network protocols, and modern CLI design patterns. While functional, it is intended primarily for learning purposes. For detailed feedback and lessons learned from this case study, see STUDY.md.


🚀 Features

📡 Protocol Support

  • FTP: Standard File Transfer Protocol support.
  • FTPS: Secure FTP over TLS/SSL (Explicit & Implicit).
  • SFTP: SSH File Transfer Protocol (v3).

💻 User Interface

  • Interactive REPL: Full shell-like experience with command history (persisted).
  • Smart Auto-completion: Context-aware completion for local/remote paths and commands.
  • Visual Feedback: Colorized output, progress bars with ETA and speed.
  • Job Control: Run transfers in background (&), list jobs, and cancel them.

🛠 Core Capabilities

  • Batch Operations: mget and mput with wildcard support (*.rs, src/*).
  • Recursive Transfers: Upload/Download entire directories with -r.
  • Resilience: Automatic resume of interrupted transfers and connection retry logic.
  • Bookmarks: Save and manage your favorite connections.
  • Security: Secure password handling in memory using zeroize.

📦 Installation

From Source

git clone https://github.com/yourusername/rustyftp.git
cd rustyftp
cargo build --release

The binary will be available at target/release/rustyftp.


⚡ Quick Start

Connecting

# Connect to FTP
rustyftp ftp --host ftp.example.com --user myuser

# Connect to SFTP
rustyftp sftp --host sftp.example.com --user myuser

# Connect to FTPS (Secure)
rustyftp ftp --host secure.example.com --user myuser --secure

Common Commands

Command Description Example
ls, lls List remote/local files ls -l
cd, lcd Change remote/local directory cd /var/www
get, put Transfer single file get backup.zip
mget, mput Batch transfer (supports wildcards) mput -r src/
jobs List background transfers jobs
bookmark Manage saved connections bookmark save myserver

📚 Documentation


🤝 Contributing

Contributions are welcome! See TODO.md for the current roadmap.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

📄 License

Distributed under the MIT License. See LICENSE for more information.


Built with ❤️ in Rust

About

FTP/FTPS/SFTP client in Rust

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages