parvardegr / sharing

Sharing is a command-line tool to share directories and files from the CLI to iOS and Android devices without the need of an extra client app

sharing

Share directories and files from the CLI to iOS and Android devices without the need of an extra client app

• share directory and file
• share your clipboard
• receive file
• support basic authentication
• support ssl

Usage

sharing is depend on node v16.x or later

1. Install
   • npm install -g easy-sharing
2. Share a file or directory
   • sharing /directory-or-file-to-share
3. Scan the QR-Code with your phone
   • both devices must connect to the same Wi-Fi or, if you have a public IP address, use the --ip parameter.
     • sharing --ip your-public-ip-address /directory-or-file-to-share
4. Tada! Just browse the directory and download any file you want

note: macos users should use easy-sharing binary instead of sharing

example: easy-sharing /file-or-directory

$ sharing --help

Usage:
• Share file or directory
$ sharing /path/to/file-or-directory

• Share clipboard
$ sharing -c

• Receive file
$ sharing /destination/directory --receive;

• Share file with Basic Authentication
$ sharing /path/to/file-or-directory -U user -P password  # also works with
--receive

Options:
      --version                     Show version number                [boolean]
      --debug                       enable debuging logs
  -p, --port                        Change default port
      --ip                          Your machine public ip address
  -c, --clipboard                   Share Clipboard
  -t, --tmpdir                      Clipboard Temporary files directory
  -w, --on-windows-native-terminal  Enable QR-Code support for windows native
                                    terminal
  -r, --receive                     Receive files
  -q, --receive-port                change receive default port
  -U, --username                    set basic authentication username
                                                               [default: "user"]
  -P, --password                    set basic authentication password
      --help                        Show help                          [boolean]

TODO

• zip the file before transferring it (sharing --zip /path/to/file)
• self-signed certificate creation
• new banner screenshot (also show the --receive functionality)

sharing's Issues

Getting undefined for port when using receive

QR code as text

Is it correct that my phone recognize de QR code as a text instead of a link?
Probably need a config.qrcode addition in index.js?

Feature: share clipboard

implement --clipboard flag to share clipboard

Run without sudo

Why sharing requires root permission? At least better explanation needed.

Publish to the network using ngrok

Describe

It is difficult to obtain public IP in some regions, we can publish to the network using ngrok.

be like:

$ sharing /path --ngrok {Authtoken}

Scheme

Here is a Node wrapper for ngrok

入口index.js报Cannot find module 'node:os'错误

这种写法是不是有兼容问题？node版本12.15.0，系统windows11，cpu：arm

Hashtag is not being properly urlencoded

If there is a hashtag in the name of the file being shared, you will get a 404.

Example:

File name:
Samurai, #1)-Ravensburger Buchverlag (2011).epub

Current encoding:
http://192.168.178.45:7478/Samurai,%20#1)-Ravensburger%20Buchverlag%20(2011).epub

Proper encoding:
http://192.168.178.45:7478/Samurai,%20%231)-Ravensburger%20Buchverlag%20(2011).epub

The second variant (replacing # with %23 works).

Something seems to be going wrong here, because I used encodeURIComponent to generate the correct url.

Sharing failed when using Windows path

When using "E:\document\temp", the valid path cannot be divided correctly

Nunjucks

What do you think if we added Nunjucks template engine to the app?
I believe it would help display information on the screen, since we will not depend on the browser's way of showing folders/files. I did an implementation in my fork. Take a look!
P.S: commits after Oct 7 are not there yet, but if you find it useful I will rebase and create a PR

[feature] support https and a basic password

It would be nice to avoid snooping, especially on public wi-fi.\

A self-signed certificate would be just fine

Directory will be cached even the directory has been changed.

Thanks for sharing the sharing tool!
I met the issue that the directory will be cached even the directory has been changed.

For example:

sharing ./my-first-directotry

The url link will look like http://192.168.2.123:7478 which is working fine at the first time by using my phone via the QR.
Then I would like to change another directory of mine.

sharing ./my-another-directotry

The generated link is completely the same with previous one like http://192.168.2.123:7478, I scan the QR and got the same directory with before.

Solution:

1. Clear the cache on my phone, use another browser or use Incognito mode(I would say it's a little boring sometimes).
2. Generate the unique link if directory has been changed(query string like ?time=xxx will be fine)

y my QR code look like this？

node:os package missing.

Getting node:os package missing. Tried adding this package globally "node:os" don't work. I've added "os" and still getting same error:

Ideally, all dependencies should be installed with original npm install command (isn't that the point?).

progress bar while sharing would be helpful

While sharing large files a progress bar would be very useful is it possible to implement that

Why generate the QR-code that cannot be scanned

Chinese and unicode are not supported

When the path contains Chinese or αβγ The QR code URL is garbled