Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/crisidev/qrsync
Utility to copy files over WiFi to/from mobile devices inside a terminal.
https://github.com/crisidev/qrsync
commadline qr-code rocket-rs rust rust-crate utility
Last synced: 14 days ago
JSON representation
Utility to copy files over WiFi to/from mobile devices inside a terminal.
- Host: GitHub
- URL: https://github.com/crisidev/qrsync
- Owner: crisidev
- License: mit
- Created: 2020-05-14T16:50:11.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-08T14:31:38.000Z (8 months ago)
- Last Synced: 2024-09-13T03:30:03.740Z (about 2 months ago)
- Topics: commadline, qr-code, rocket-rs, rust, rust-crate, utility
- Language: Rust
- Size: 3.5 MB
- Stars: 17
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
## QrSync
[](https://github.com/crisidev/qrsync/actions?query=workflow%3Arelease)
[](https://github.com/crisidev/qrsync/actions?query=workflow%3Aci)
[](https://crates.io/crates/qrsync)
[](https://docs.rs/crate/qrsync)
[](https://crates.io/crates/qrsync)
[](https://github.com/crisidev/qrsync/blob/master/LICENSE)
Utility to copy files over WiFi to/from mobile devices inside a terminal.
- [Install](#install)
- [Rust version](#rust-version)
- [Platforms support](#platforms-support)
- [Operational modes](#operational-modes)
- [IPv6 support](#ipv6-support)
- [Command line options](#command-line-options)
- [Acknowledgement](#acknowledgement)
- [License](#license)
When I built QrSync, it was only meant to send files from a terminal to a mobile device, then I
found the amazing [qrcp](https://github.com/claudiodangelis/qrcp) and I took some ideas from it and
implemented also the possibility to copy file from the mobile device to the computer running QrSync.
### Install
Github Actions releases [binaries](https://github.com/crisidev/qrsync/releases) for various architectures when a new tag is pushed:
* x84-64 Linux GNU
* x86-64 Darwin
* aarch64 Linux GNU
* armv7 Linux GNU
Alternatively you can install the latest tag directly from [crates.io](https://crates.io/crates/qrsync):
```sh
❯❯❯ cargo install qrsync
```
### Rust version
QrSync builds against stable Rust >= 1.60.
### Platforms support
QrSync has been tested on Linux and MacOSX.
It currently also build against Windows, but it has not being tested. On \*nix it uses [pnet](https://github.com/libpnet/libpnet) to auto discover the primary interface and its IP address and bind against it. Pnet have a some complex dependencies to build against Windows (see [here](https://github.com/libpnet/libpnet#windows) for more info), so on this platform QrSync makes the `--ip-address` command-line option mandatory and `pnet` is not built at all.
### Operational modes
QrSync can run in two modes, depending on command line options:
* **Send mode:** this mode is selected when a file is passed to the command line. QrSync will
generate a QR code on the terminal and start the HTTP server in send mode.
Example:
```sh
❯❯❯ qrsync my_document.pdf
INFO qrsync::http > Send mode enabled for file /home/bigo/my_document.pdf
INFO qrsync::http > Scan this QR code with a QR code reader app to open the URL http://192.168.1.11:5566/Q2FyZ28udG9tbA
```
* **Receive mode:** this mode is selected if no file is passed to the command line. QrSync will
generate a QR code on the terminal and start the HTTP server in receive mode from the current
folder. A specific folder to save received files can be specified with --root-dir command line
option.
Example:
```sh
❯❯❯ qrsync
INFO qrsync::http > Receive mode enabled inside directory /home/bigo
INFO qrsync::http > Scan this QR code with a QR code reader app to open the URL http://192.168.1.11:5566/receive
```
### IPv6 support
QrSync tries to guess which interface to use and which address to bind on the selected interface. In case you want to use IPv6, ensure you have a valid non link-local address and specify `--ipv6` command line argument. Remember, the IP address can be always overridden using `--ip-address` command line argument.
### Command line options
```sh
USAGE:
qrsync [FLAGS] [OPTIONS] [filename]
ARGS:
File to be send to the mobile device
FLAGS:
-d, --debug Enable QrSync debug
-h, --help Prints help information
-6, --ipv6 Prefer IPv6 over IPv4
-l, --light-term Draw QR in a terminal with light background
-v, --version Prints version information
OPTIONS:
-i, --ip-address IP address to bind the HTTP server to. Default to primary interface
-p, --port Port to bind the HTTP server to [default: 5566]
-r, --root-dir Root directory to store files in receive mode
```
### Acknowledgement
* [qrcp](https://github.com/claudiodangelis/qrcp): I took many ideas from this amazing project
and "stole" most of the HTML Bootstrap based UI.
* [axum](https://github.com/tokio-rs/axum/): A great HTTP framework for Rust, very expandable and simple to
use.
* [qr2term](https://docs.rs/qr2term/): Terminal based QR rendering library.
### License
See [LICENSE](https://github.com/crisidev/qrsync/blob/master/LICENSE) file.