t-share
Version:
Share Files And Directories from your Terminal
58 lines (47 loc) • 2.07 kB
Markdown
# t-share | Share files and directories from terminal
**Share** directories and files from the CLI to iOS and Android devices without the need of an extra client app
FEATURES:
- share directory and file
- share your clipboard
- receive file
- support basic authentication
- support ssl
## Usage
*t-share is depend on node v16.x or later*
1. Install
- `npm install t-share`
2. Share a file or directory
- `t-share /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.
- `t-share --ip your-public-ip-address /directory-or-file-to-share`
4. Tada! Just browse the directory and download any file you want
```
$ t-share --help
Usage:
• Share file or directory
$ t-share /path/to/file-or-directory
• Share clipboard
$ t-share -c
• Receive file
$ t-share /destination/directory --receive;
• Share file with Basic Authentication
$ t-share /path/to/file-or-directory -U user -P password # also works with
--receive
Options:
--version Show version number [boolean]
--author Get to know the library AUTHOR
--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]
```