View on GitHub

KelpsGet

A modern, lightweight wget clone written in Rust for fast and reliable file downloads from the command line.

KelpsGet now is KGet! v1.5.0 (New Release)

A modern, lightweight, and versatile downloader written in Rust for fast and reliable file downloads via command line (CLI) and graphical user interface (GUI).

English Português Español

Screenshots

How It Works (Summary)

  1. Progress Bar (CLI): Shows speed, ETA, and transferred bytes.
  2. Smart File Naming:
    • Uses the filename from the URL.
    • Defaults to index.html if the URL ends with /.
  3. Error Handling: Exits with code 1 on HTTP errors (e.g., 404).
  4. Space Check: Verifies available disk space.
  5. Automatic Retry: Retries download on network failure.
  6. Advanced Download Mode (HTTP/HTTPS): Downloads in parallel chunks, supports resume.
  7. Proxy Support: HTTP, HTTPS, SOCKS5 with authentication.
  8. Optimization Features: Compression (for cache), file caching, speed limiting.
  9. Torrent Downloads: Adds magnet links to transmission-daemon for download.
  10. FTP/SFTP Downloads: Connects to FTP/SFTP servers to transfer files.

Features

See the full list of features and recent changes in the CHANGELOG.

KGet now is a Crate too!

If you want to use KGet as a crate you can click here.

Installation

You will need Rust installed. If you don’t have it, install it from rustup.rs.

Install some dependencies: For Debian/Ubuntu based systems:

sudo apt update
sudo apt install -y libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libxkbcommon-dev libssl-dev pkg-config

For Fedora:

sudo dnf install -y libxcb-devel libxkbcommon-devel openssl-devel pkg-config

Clone the repository and compile the project:

git clone https://github.com/davimf721/KGet.git
cd KGet
cargo build --release

The executable will be in target/release/kget. You can copy it to a directory in your PATH:

sudo cp target/release/kget /usr/local/bin/

Option 2: Install via Cargo

cargo install Kget

If you encounter issues with the GUI when installing via cargo install, compiling from source is more reliable.

Option 3: Download Pre-compiled Binaries

Check the Releases section for the latest binaries for your OS.

Linux/macOS:

chmod +x ksget  # Make executable
./kelpsget [URL]    # Run directly

Windows:

Run the .exe file directly.

Additional Requirement for Torrent Downloads: Transmission Daemon

KGet uses the transmission-daemon to manage torrent downloads.

1. Install Transmission Daemon:

2. Stop the Daemon for Configuration:

sudo systemctl stop transmission-daemon

3. Configure Transmission: Edit the settings.json file. Common locations:

Use sudo nano /var/lib/transmission-daemon/info/settings.json (or the correct path for your system).

Find and modify these lines:

{
    // ...
    "rpc-authentication-required": true,
    "rpc-enabled": true,
    "rpc-password": "transmission", // This is the value KGet uses by default to connect to Transmission (recommended)
    "rpc-port": 9091,
    "rpc-username": "transmission", // Username KGet uses to connect to Transmission
    "rpc-whitelist-enabled": false, // For local access. For remote access, configure IPs.
    "download-dir": "/var/lib/transmission-daemon/downloads", // Transmission's default download directory
    // ...
}

Important: After saving and starting transmission-daemon, it will replace the plain text rpc-password with a hashed version.

4. (Optional) Adjust Daemon User Permissions: If transmission-daemon runs as a specific user (e.g., debian-transmission or transmission), ensure this user has write permissions in the download directories you intend to use with KelpsGet or Transmission itself. You can add your user to the Transmission daemon’s group:

sudo usermod -a -G debian-transmission your_linux_user # For Debian/Ubuntu
# Check the Transmission group/user name on your system

5. Start the Transmission Daemon:

sudo systemctl start transmission-daemon
# Check status:
sudo systemctl status transmission-daemon

Access http://localhost:9091 in your browser. You should see the Transmission web interface and be prompted to log in with the rpc-username and rpc-password you configured.

Usage

Command Line (CLI)

kget [OPTIONS] <URL>

Examples:

Graphical User Interface (GUI)

To start the GUI:

kget --gui

The GUI allows you to enter the URL, output path, and start downloads. Status and progress are displayed in the interface.

KelpsGet Configuration

KelpsGet uses a configuration file at:

Example config.json for KGet:

{
  "proxy": {
    "enabled": false,
    "url": null,
    "username": null,
    "password": null,
    "proxy_type": "Http"
  },
  "optimization": {
    "compression": true, // Compression for KGet cache
    "compression_level": 6,
    "cache_enabled": true,
    "cache_dir": "~/.cache/kget", // Expand ~ manually or use absolute path
    "speed_limit": null,
    "max_connections": 4
  },
  "torrent": {
    "enabled": true,
    "transmission_url": "http://localhost:9091/transmission/rpc",
    "username": "transmission", // User configured in Transmission's settings.json
    "password": "transmission", // Password configured in Transmission's settings.json
    "max_peers": 50,
    "max_seeds": 50,
    "port": null,
    "dht_enabled": true,
    "default_download_dir": null // Default directory for torrent downloads via KGet
  },
  "ftp": {
    "default_port": 21,
    "passive_mode": true
  },
  "sftp": {
    "default_port": 22,
    "key_path": null // Path to private SSH key, e.g., "~/.ssh/id_rsa"
  }
}

Note on cache_dir and key_path: If using ~, ensure your program correctly expands the tilde to the user’s home directory, or use absolute paths.

🔗 Important Links

You can see posts about the project in others communities:

Contributing

Want to contribute? Check out our contribution guide!

Found a bug or want to add a feature? Open an issue or send a PR!

🚀 Download files effortlessly with the speed and reliability of Rust. 🚀

License

This project is licensed under the MIT License - see the LICENSE file for details.