170 lines
7.6 KiB
Markdown
170 lines
7.6 KiB
Markdown
<h1 align="center">
|
||
<a href="https://rcloneui.com">
|
||
<img src="./public/banner.png" alt="Rclone UI" width="100%">
|
||
</a>
|
||
<br>
|
||
<a href="https://rcloneui.com">
|
||
The cross-platform GUI for Rclone
|
||
</a>
|
||
</h1>
|
||
|
||
<h3 align="center">
|
||
<strong>A light, transparent layer on top of <tt>rclone</tt> to manage your remotes & tasks in a more user-friendly way.</strong>
|
||
</h3>
|
||
|
||
<br />
|
||
|
||
<p align="center">
|
||
<a href="https://discord.gg/rclone">
|
||
<img alt="Discord" src="https://img.shields.io/badge/Discord-%235865F2.svg?&logo=discord&logoColor=white&style=for-the-badge" />
|
||
</a>
|
||
|
||
<a href="https://github.com/rclone-ui/rclone-ui?tab=readme-ov-file#package-managers">
|
||
<img alt="Downloads on Github" src="https://img.shields.io/github/downloads/rclone-ui/rclone-ui/total?style=for-the-badge">
|
||
</a>
|
||
</p>
|
||
|
||
<br />
|
||
|
||
<a href="https://get.rcloneui.com/showcase">
|
||
<img src=".github/rclone-video.png" alt="The GUI for Rclone">
|
||
</a>
|
||
|
||
## Package Managers
|
||
|
||
<table>
|
||
<tr>
|
||
<td><a href="https://flathub.org/en/apps/com.rcloneui.RcloneUI"><img alt="Flathub" src="https://img.shields.io/badge/Flathub-000000?style=for-the-badge&logo=flathub" /></a></td>
|
||
<td width="700">
|
||
|
||
```bash
|
||
flatpak install com.rcloneui.RcloneUI
|
||
```
|
||
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://formulae.brew.sh/cask/rclone-ui"><img alt="Homebrew" src="https://img.shields.io/badge/Brew-1f1d1a?style=for-the-badge&logo=homebrew" /></a></td>
|
||
<td>
|
||
|
||
```bash
|
||
brew install --cask rclone-ui
|
||
```
|
||
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://scoop.sh"><img alt="Scoop" src="https://img.shields.io/badge/Scoop-4d2a7a?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCIgZmlsbD0id2hpdGUiPjxwYXRoIGQ9Ik0wIDMuNDQ5TDkuNzUgMi4xdjkuNDUxSDBtMTAuOTQ5LTkuNjAyTDI0IDB2MTEuNEgxMC45NDlNMCAxMi42aDkuNzV2OS40NTFMMCAyMC42OTlNMTAuOTQ5IDEyLjZIMjRWMjRsLTEyLjktMS44MDEiLz48L3N2Zz4K" /></a></td>
|
||
<td>
|
||
|
||
```bash
|
||
scoop bucket add extras && scoop install rclone-ui
|
||
```
|
||
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://community.chocolatey.org/packages/rclone-ui"><img alt="Chocolatey" src="https://img.shields.io/badge/Chocolatey-42345f?style=for-the-badge&logo=chocolatey" /></a></td>
|
||
<td>
|
||
|
||
```bash
|
||
choco install rclone-ui
|
||
```
|
||
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://winstall.app/apps/RcloneUI.RcloneUI"><img alt="WinGet" src="https://img.shields.io/badge/WinGet-0078d4?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCIgZmlsbD0id2hpdGUiPjxwYXRoIGQ9Ik0wIDMuNDQ5TDkuNzUgMi4xdjkuNDUxSDBtMTAuOTQ5LTkuNjAyTDI0IDB2MTEuNEgxMC45NDlNMCAxMi42aDkuNzV2OS40NTFMMCAyMC42OTlNMTAuOTQ5IDEyLjZIMjRWMjRsLTEyLjktMS44MDEiLz48L3N2Zz4K" /></a></td>
|
||
<td>
|
||
|
||
```bash
|
||
winget install --id=RcloneUI.RcloneUI -e
|
||
```
|
||
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://www.npmjs.com/package/rclone-ui"><img alt="NPM" src="https://img.shields.io/badge/NPM-cb3837?style=for-the-badge&logo=npm" /></a></td>
|
||
<td>
|
||
|
||
```bash
|
||
npx rclone-ui
|
||
```
|
||
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://apps.apple.com/app/rclone-ui/id6756127598"><img alt="App Store" src="https://img.shields.io/badge/App_Store-0D96F6?style=for-the-badge&logo=app-store&logoColor=white" /></a></td>
|
||
<td><a href="https://apps.apple.com/app/rclone-ui/id6756127598"><b>Tap here to open the Apple App Store</b></a></td>
|
||
</tr>
|
||
<tr>
|
||
<td><a href="https://play.google.com/store/apps/details?id=com.rclone.mobile"><img alt="Google Play" src="https://img.shields.io/badge/Google_Play-414141?style=for-the-badge&logo=google-play&logoColor=white" /></a></td>
|
||
<td><a href="https://play.google.com/store/apps/details?id=com.rclone.mobile"><b>Tap here to open the Google Play Store</b></a></td>
|
||
</tr>
|
||
</table>
|
||
|
||
> You may run into incompatibilities if you run the app on a machine or VM with Nvidia. In that case you can open it from the terminal with a special flag: `flatpak override --user --env=WEBKIT_DISABLE_DMABUF_RENDERER=1 com.rcloneui.RcloneUI`
|
||
|
||
## Downloads
|
||
- **Windows** (**[Arm](https://get.rcloneui.com/win-arm)**, **[x64](https://get.rcloneui.com/win)**)
|
||
- **macOS** (**[Apple Silicon](https://get.rcloneui.com/mac)**, **[Intel](https://get.rcloneui.com/mac64)**)
|
||
- **Linux** (**[AppImage](https://get.rcloneui.com/linux)**, **[deb](https://get.rcloneui.com/linux-deb)**, **[rpm](https://get.rcloneui.com/linux-rpm)**)
|
||
- **Linux `Arm`** (**[AppImage](https://get.rcloneui.com/linux-arm)**, **[deb](https://get.rcloneui.com/linux-deb-arm)**, **[rpm](https://get.rcloneui.com/linux-rpm-arm)**)
|
||
|
||
## Docker/Homelab/Server Usage
|
||
Control your server, homelab, or mom's PC with **the easiest solution to manage remote **`rclone`** instances.**
|
||
|
||
[**Check out the guide for controlling remote instances.**](https://rcloneui.com/docs/ui/docker)
|
||
|
||
## Roadmap
|
||
> Finalized items have been moved to the "Features" section.
|
||
### [Check out the V3 discussion!](https://github.com/rclone-ui/rclone-ui/issues/18)
|
||
|
||
## 1 Star = 1 Instant Coffee
|
||
<a href="https://www.star-history.com/#rclone-ui/rclone-ui&Timeline">
|
||
<picture>
|
||
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=rclone-ui/rclone-ui&type=Timeline&theme=dark&sealed_token=ymt1q4Qq0l91e5fCgYfVLA1txvhP-b2epzcYv0PUyWAZGMjSwyU4dK7Et21VWygM8k6aZFa30W1IlpScqFoDRO9sITVkSmwI2BzpKv95JBWuJ9ujXftyeO7v0vt3IFBQb4yJSVB77XBU8p6Hr-ycR0Q_nHLbKjQulfdtsjPHgNQyBA_2kjeFFTy45dMO"" />
|
||
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=rclone-ui/rclone-ui&type=Timeline&sealed_token=ymt1q4Qq0l91e5fCgYfVLA1txvhP-b2epzcYv0PUyWAZGMjSwyU4dK7Et21VWygM8k6aZFa30W1IlpScqFoDRO9sITVkSmwI2BzpKv95JBWuJ9ujXftyeO7v0vt3IFBQb4yJSVB77XBU8p6Hr-ycR0Q_nHLbKjQulfdtsjPHgNQyBA_2kjeFFTy45dMO" />
|
||
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=rclone-ui/rclone-ui&type=Timeline&sealed_token=ymt1q4Qq0l91e5fCgYfVLA1txvhP-b2epzcYv0PUyWAZGMjSwyU4dK7Et21VWygM8k6aZFa30W1IlpScqFoDRO9sITVkSmwI2BzpKv95JBWuJ9ujXftyeO7v0vt3IFBQb4yJSVB77XBU8p6Hr-ycR0Q_nHLbKjQulfdtsjPHgNQyBA_2kjeFFTy45dMO" />
|
||
</picture>
|
||
</a>
|
||
|
||
## Contributing
|
||
Welcome, anon. We’ve been expecting you.
|
||
|
||
Here are some good problems to tackle:
|
||
- Fix an open [**Issue**](https://github.com/rclone-ui/rclone-ui/issues)
|
||
- Upgrade repository to Vite 7 & React 19
|
||
- Introduce React Compiler
|
||
|
||
🎁 **Merged PRs receive a Lifetime License!**
|
||
|
||
<br />
|
||
|
||
<p align="center">
|
||
<a href="https://github.com/rclone-ui/rclone-ui/blob/main/README.md">
|
||
<img alt="English" src="https://img.shields.io/badge/ENGLISH-chartreuse?style=for-the-badge" />
|
||
</a>
|
||
<a href="https://github.com/rclone-ui/rclone-ui/blob/main/README_CHINESE.md">
|
||
<img alt="Chinese" src="https://img.shields.io/badge/CHINESE-gray?style=for-the-badge" />
|
||
</a>
|
||
<a href="https://github.com/rclone-ui/rclone-ui/blob/main/README_JAPANESE.md">
|
||
<img alt="Japanese" src="https://img.shields.io/badge/JAPANESE-gray?style=for-the-badge" />
|
||
</a>
|
||
<a href="https://github.com/rclone-ui/rclone-ui/blob/main/README_POLISH.md">
|
||
<img alt="Polish" src="https://img.shields.io/badge/POLISH-gray?style=for-the-badge" />
|
||
</a>
|
||
<a href="https://github.com/rclone-ui/rclone-ui/blob/main/README_GERMAN.md">
|
||
<img alt="German" src="https://img.shields.io/badge/GERMAN-gray?style=for-the-badge" />
|
||
</a>
|
||
<a href="https://github.com/rclone-ui/rclone-ui/blob/main/README_SPANISH.md">
|
||
<img alt="Spanish" src="https://img.shields.io/badge/SPANISH-gray?style=for-the-badge" />
|
||
</a>
|
||
<a href="https://github.com/rclone-ui/rclone-ui/blob/main/README_ROMANIAN.md">
|
||
<img alt="Romanian" src="https://img.shields.io/badge/ROMANIAN-gray?style=for-the-badge" />
|
||
</a>
|
||
<a href="https://github.com/rclone-ui/rclone-ui/blob/main/README_PIRATE.md">
|
||
<img alt="Pirate" src="https://img.shields.io/badge/PIRATE-gray?style=for-the-badge" />
|
||
</a>
|
||
</p>
|