MCPcopy Index your code
hub / github.com/Martichou/rquickshare

github.com/Martichou/rquickshare @v0.11.5

Chat with this repo
repository ↗ · DeepWiki ↗ · release v0.11.5 ↗ · + Follow
227 symbols 439 edges 99 files 2 documented · 1% updated 2mo agov0.11.5 · 2025-02-23★ 3,54762 open issues
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

rquickshare

<strong>NearbyShare/QuickShare for Linux and MacOS</strong>

CI CI

demo image

Installation

You simply have to download the latest release.

Important notes: - The minimum GLIBC version supported is included in the pkg name. - You can check yours with ldd --version. - RQuickShare is distributed with two version (main & legacy): - Legacy is for compatibility with older Ubuntu versions. - Main is for future support of newer versions of Ubuntu.

macOS

Simply install the .dmg.

Note that you may have to first allow the app to install under Settings > Privacy & Security > Security (you should see a dialog asking for permission)

Linux

Install dependencies

RQuickShare requires one of the following libraries to be installed:

  • libayatana-appindicator
  • libappindicator3

The files should (in theory) install those dependencies by themselves, but if this is not the case you may have to install those manually.

Install rquickshare
sudo dpkg -i r-quick-share_${VERSION}.deb

Debian

sudo dpkg -i r-quick-share_${VERSION}.deb

RPM

sudo rpm -i r-quick-share-${VERSION}.rpm

DNF (preferred over RPM)

sudo dnf install r-quick-share-${VERSION}.rpm

AppImage (no root required)

AppImage is a little different. There's no installation needed, you simply have to give it the executable permission (+x on a chmod) to run it.

chmod +x r-quick-share_${VERSION}.AppImage

You can then either double click on it, or run it from the cmd line:

./r-quick-share_${VERSION}.AppImage

Snap

The snap is not yet on the store, but you can install it with the following (you may need sudo):

snap install --dangerous r-quick-share_${VERSION}.snap

Unofficial Installation Methods

AUR (Arch)

For Arch Linux, you can install it from the AUR by using an AUR helper like yay:

yay -S r-quick-share

Nix

Available here: NixOS

A nix-shell will temporarily modify your $PATH environment variable. This can be used to try a piece of software before deciding to permanently install it.

$ nix-shell -p rquickshare

Limitations

  • Wi-Fi LAN only. Your devices need to be on the same network for this app to work.

FAQ

My Android device doesn't see my laptop

Make sure both your devices are on the same WiFi network. mDNS communication should be allowed on the network; this may not be the case if you're on a public network (coffee shops, airports, etc.).

My laptop doesn't see my Android device

For some reason, Android doesn't broadcast its mDNS service all the time, even when in "Everyone" mode.

The first solution (implemented in RQuickShare for Linux) is to broadcast a bluetooth advertisement so that Android will then make its mDNS available. Of course, for this you need to have bluetooth on your laptop/desktop. If you don't have that, continue reading.

As a workaround, you can use the "Files" app on your Android device and go to the "Nearby Share" tab (if it's not present, continue reading).

A second workaround is to download a Shortcut maker (see here) to create a shortcut to the particular intent:

  • Method A:

    • Activity: com.google.android.gms.nearby.sharing.ReceiveSurfaceActivity
  • Method B:

    • Action: com.google.android.gms.RECEIVE_NEARBY
    • Mime type: */*

Note: Samsung did something shady with Quick Share, so the above workaround may not work. Unfortunately, there's no alternative at the moment. Sorry.

When sharing a file, my phone appears and disappears "randomly"

TLDR: This is normal if you're just using bluetooth (as explained in the previous point).

Android will see that your laptop/desktop is trying to share a file and will reveal itself. But for some reason, Android will de-register its service from time to time and will only then be revealed again once it detects the bluetooth message again.

Once I close the app, it won't reopen

Make sure the app is really closed by running:

ps aux | grep r-quick-share

If you see that the process is still running, it's because the app is not closed. This may be an intended behavior: when closing the window, the app won't stop and instead is still running and accessible via the system tray icon. However, if your distribution doesn't support/hasn't enabled this, it may be an issue for you.

If you want to really close the app when clicking on the close button, you can change that inside the app by clicking on the three dots and then "Stop app on close".

My firewall is blocking the connection

In this case, you may want to configure a static port to allow it in your firewall. You can do so by modifying the config file as follow:

# linux
vim ./.local/share/dev.mandre.rquickshare/.settings.json

# mac
vim Library/Application\ Support/dev.mandre.rquickshare/.settings.json

# to be sure
find $HOME -name ".settings.json"

[!WARNING]

The json must stay valid after your modification; for example, if "port" is the last item of the JSON it must not have a comma after it, otherwise the config will be reset.

{
    ...existing_config...,
    "port": 12345
}

By default the port is random (the OS will decide).

The app opens but I just get a blank window or cannot run it.

This happens for some users running Linux + NVIDIA cards.

The workaround is to start RQuickShare with an env variable defined as follows:

env WEBKIT_DISABLE_COMPOSITING_MODE=1 rquickshare

Alternatively, you may try the legacy variant.

WIP Notes

rquickshare is still in development (WIP) and currently only supports Linux even though it should be compatible with macOS too. Keep in mind that the design may change between versions, so flexibility is key.

Got feedback or suggestions? We'd love to hear them! Feel free to open an issue and share your thoughts.

Credits

This project wouldn't exist without those amazing open-source project:

  • https://github.com/grishka/NearDrop
  • https://github.com/vicr123/QNearbyShare

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Extension points exported contracts — how you extend this code

Core symbols most depended-on inside this repo

Shape

Function 114
Method 72
Class 17
Enum 12
Interface 12

Languages

Rust74%
TypeScript26%

Modules by API surface

core_lib/src/hdl/inbound.rs25 symbols
core_lib/src/hdl/outbound.rs24 symbols
app/main/src/vue_lib/utils.ts19 symbols
app/legacy/src/vue_lib/utils.ts19 symbols
core_lib/src/utils.rs16 symbols
core_lib/src/lib.rs9 symbols
app/main/src-tauri/src/store.rs9 symbols
app/legacy/src-tauri/src/main.rs9 symbols
app/main/src-tauri/src/main.rs8 symbols
app/legacy/src-tauri/src/store.rs8 symbols
core_lib/src/hdl/mdns.rs6 symbols
core_lib/src/manager.rs5 symbols

For agents

$ claude mcp add rquickshare \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page