mateoradman / swift_file

Share files between devices using your Wi-Fi network.

swift_file

Rust implementation of transferring files between devices over Wi-Fi network using a QR code. Tool is inspired by claudiodangelis/qrcp.

How does it work?

The sf server is bound to the IP address of a default network interface of the machine the server is running on. Alternatively, the IP address (--port), particular network interface (--interface), and port (--port) can be selected by the user.

The QR code that is printed encodes a http URL which is typically of the following format:

http://{ip}:{port}/{download|receive}/[optional suffix]

Known limitations

• Some browsers on iOS are unable to download the file. It always works with Safari but fails with Brave. The failed download might also occur on other Chromium-based iOS browsers.

Safety

This crate uses #![forbid(unsafe_code)] to ensure everything is implemented in 100% safe Rust.

Installation options

Install with cargo

swift_file is published on crates.io. In order to install a Rust crate from crates.io, it is required to have Rust and cargo installed on your system.

cargo install swift_file

Manual installation from an archive

Latest release page provides an option to manually install the sf binary from an archive. The archive is available for Linux, MacOS, and Windows. Download, extract and move the binary to the desired directory, and set execution permissions.

Linux

1. Download the Linux tar.gz archive from the latest release
2. Extract the archive

tar xf swift_file_*_x86_64-unknown-linux-musl.tar.gz

3. Move the binary

sudo mv sf /usr/local/bin

4. Set execution permissions

sudo chmod +x /usr/local/bin/sf

5. Run sf

sf --help

MacOS

1. Download the MacOS (apple-darwin) ZIP archive from the latest release
2. Extract the archive

unzip swift_file_*_x86_64-apple-darwin.zip

3. Move the binary

sudo mv sf /usr/local/bin

4. Set execution permissions

sudo chmod +x /usr/local/bin/sf

5. Run sf

sf --help

Windows

1. Download the Windows ZIP archive from the latest release
2. Extract the archive
3. Run sf.exe

CLI Usage

Send or receive files between devices using Wi-Fi network

Usage: sf [OPTIONS] <COMMAND>

Commands:
  send     Send a file
  receive  Receive a file
  help     Print this message or the help of the given subcommand(s)

Options:
      --ip <IP>                IP Address to bind to
  -i, --interface <INTERFACE>  Network interface to use (ignored if --ip provided)
  -p, --port <PORT>            Server port
  -h, --help                   Print help
  -V, --version                Print version

Sending a file to another device

Send a file

Usage: sf send [OPTIONS] <FILE>

Arguments:
  <FILE>  File path to send

Options:
      --ip <IP>                IP Address to bind to
      --zip                    ZIP file or directory before transferring
  -i, --interface <INTERFACE>  Network interface to use (ignored if --ip provided)
  -p, --port <PORT>            Server port
  -h, --help                   Print help

Receiving files from another device

Receive files

Usage: sf receive [OPTIONS]

Options:
  -d, --dest-dir <DEST_DIR>    Destination directory
      --ip <IP>                IP Address to bind to
  -i, --interface <INTERFACE>  Network interface to use (ignored if --ip provided)
      --no-open                Disable opening the received file automatically using the system default program
  -p, --port <PORT>            Server port
  -h, --help                   Print help

swift_file's Issues

Improve docs

Add more information on how to install and use swift_file

Is there a way to specify the IP or network interface?

sf seems to bind to the first device it finds. In my case these are not accessible from outside the computer, so my mobile cannot connect.

Can I specify which IP address or what network device (lo, wlo1, enx806d973060ab, etc...) sf will use?

Add possibility to run in Docker

--no-open still opens the received file

Hi, I'm having issues with the --no-open flag as it still opens the file after the file was received.

This is my command and the output:

> sf receive --no-open
URL: http://192.168.169.68:1024/receive
<QR CODE>
Server launched on 0.0.0.0:1024
File `file.jpg` with content type `image/jpeg`, size 72823 bytes has been transferred to /path/to/file.jpg
File opened using a default program.

I'm using version 0.1.5 of swift_file on Ubuntu 22.04.2 LTS x86_64

Thanks for the awesome project!

Confusing project name

Come up with a different name for Swift File which does not include another programming language in the name.

ZIP content before transferring

Allow users to ZIP contents before sending them to allow sending multiple files or folders at once.