https://github.com/mateoradman/swift_file
Share files between devices using your Wi-Fi network.
https://github.com/mateoradman/swift_file
axum cli command-line-tool file-sharing file-transfer rust
Last synced: 2 months ago
JSON representation
Share files between devices using your Wi-Fi network.
- Host: GitHub
- URL: https://github.com/mateoradman/swift_file
- Owner: mateoradman
- License: mit
- Created: 2023-04-17T09:17:11.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-04T22:02:58.000Z (over 1 year ago)
- Last Synced: 2025-03-24T13:05:10.283Z (3 months ago)
- Topics: axum, cli, command-line-tool, file-sharing, file-transfer, rust
- Language: Rust
- Homepage: https://crates.io/crates/swift_file
- Size: 378 KB
- Stars: 14
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# swift_file
Rust implementation of transferring files between devices over Wi-Fi network using a QR code.
Tool is inspired by [claudiodangelis/qrcp](https://github.com/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](https://crates.io/crates/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](https://doc.rust-lang.org/cargo/getting-started/installation.html) on your system.
```sh
cargo install swift_file
```
### Manual installation from an archive
[Latest release](https://github.com/mateoradman/swift_file/releases/latest) 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](https://github.com/mateoradman/swift_file/releases/latest)
2. Extract the archive
```sh
tar xf swift_file_*_x86_64-unknown-linux-musl.tar.gz
```
3. Move the binary
```sh
sudo mv sf /usr/local/bin
```
4. Set execution permissions
```sh
sudo chmod +x /usr/local/bin/sf
```
5. Run sf
```sh
sf --help
```
#### MacOS
1. Download the MacOS (apple-darwin) ZIP archive from the latest [release](https://github.com/mateoradman/swift_file/releases/latest)
2. Extract the archive
```sh
unzip swift_file_*_x86_64-apple-darwin.zip
```
3. Move the binary
```sh
sudo mv sf /usr/local/bin
```
4. Set execution permissions
```sh
sudo chmod +x /usr/local/bin/sf
```
5. Run sf
```sh
sf --help
```
#### Windows
1. Download the Windows ZIP archive from the latest [release](https://github.com/mateoradman/swift_file/releases/latest)
2. Extract the archive
3. Run sf.exe
## CLI Usage
```
Send or receive files between devices using Wi-Fi network
Usage: sf [OPTIONS]
Commands:
send Send a file
receive Receive a file
help Print this message or the help of the given subcommand(s)
Options:
--ip IP Address to bind to
-i, --interface Network interface to use (ignored if --ip provided)
-p, --port Server port
-h, --help Print help
-V, --version Print version
```
### Sending a file to another device
```
Send a file
Usage: sf send [OPTIONS]
Arguments:
File path to send
Options:
--ip IP Address to bind to
--zip ZIP file or directory before transferring
-i, --interface Network interface to use (ignored if --ip provided)
-p, --port Server port
-h, --help Print help
```
### Receiving files from another device
```
Receive files
Usage: sf receive [OPTIONS]
Options:
-d, --dest-dir Destination directory
--ip IP Address to bind to
-i, --interface Network interface to use (ignored if --ip provided)
--no-open Disable opening the received file automatically using the system default program
-p, --port Server port
-h, --help Print help
```