Skip to content

Latest commit

 

History

History
119 lines (89 loc) · 2.25 KB

README.md

File metadata and controls

119 lines (89 loc) · 2.25 KB

QShare

.NET CLI tool for local network file sharing

Receiver doesn't have to install qshare or any other 3rd party application (just a web browser).

Features

  • Receive files via web browser
  • QR Code scanning (coming soon)
  • Upload files via browser (coming soon)

Requirements

  • .NET 6 and later

Quickstart

Installing

1. Clone the repo

git clone https://github.com/AhmedKabbary/QShare QShare
cd QShare

2. Pack the project

cd src
dotnet pack

3. Install the tool

dotnet tool install --global --add-source ./nupkg Qabbary.QShare

Updating

Change the current working directory to the cloned repo directory before updating.

1. Pull the latest changes

git pull

2. Pack the project

cd src
dotnet pack

3. Update the tool

dotnet tool update --global --add-source ./nupkg Qabbary.QShare

Uninstalling

dotnet tool uninstall --global Qabbary.QShare

Don't forget to remove the cloned repo directory.

Usage

  • Connect the other device to the same local network.
  • Execute the qshare command with the appropriate arguments.
  • Open the web browser on the other device and enter the url appeared in the terminal.

Soon you will be able to scan a QR code instead of typing the url manually.

Arguments

Argument Description
-?, -h, --help Show help and usage information
-i, --include Specifies files to include in sharing
-e, --exclude Specifies files to exclude from sharing
-p, --port Specifies http server port number
--version Show version information

Examples

Share all files in top-level directory

qshare

Share a single file

qshare -i book.pdf

Share multiple files

qshare -i book1.pdf book2.pdf

Share all files with extension '.pdf'

qshare -i *.pdf

Share all files with extension '.pdf' except 'book.pdf'

qshare -i *.pdf -e book.pdf

Share all files with extension '.css' in the directory 'styles/'.

qshare -i styles/*.css

Share all files in any subdirectory

qshare -i **/*

License

QShare is licensed under the MIT license.