Syncshell (Syncthing + quickshell) is a plugin to show Syncthing file activity from the Omarchy bar. The plugin can manage local folders, open Syncthing's Web UI, control the user service, and many more. While originally developed for Omarchy its next release will refactor the plugin to be usable on any Linux quickshell build.
- select the switch/toggle in the top right to start or stop the user service
- select a folder card to open its directory
- select + to configure an existing local directory
- select Refresh to request an immediate health update
- select Open Web UI for device setup and advanced folder options
- select the gear or press
sfor appearance settings and clean removal
omarchy plugin add https://github.com/ilyaZar/syncshell.git --enableOpen the widget and expand More. If Syncthing is missing, select Install
Syncthing. The plugin runs omarchy pkg add syncthing, then enables and
starts syncthing.service. If Syncthing is already installed, the plugin should
auto-detect this.
As shown in the footer at the bottom of the main plugin menu
| Key | Action |
|---|---|
r |
refresh status |
w |
open the Web UI |
p |
start or stop the service |
s |
open plugin settings |
q |
close the panel |
esc |
close the panel |
The settings menu opens ~/.config/omarchy/ilyazar.syncthing/settings.toml in
the default editor. The file is created only when it is first opened, and
changes apply when saved. New files use configuration version 1, with
appearance options grouped under the [style] section. Existing files are never
overwritten.
style.icon_style = "branded"uses the classic Syncthing bar icon. Usethemedfor an icon colored by the active Omarchy theme.style.web_ui_theme = "omarchy"applies the complete Omarchy palette to Syncthing's Web UI. Usedefaultfor Syncthing's own styling.
Changing the Omarchy theme regenerates the Web UI palette immediately. An open
Web UI applies the new colors without a page reload. The generated Omarchy theme
is separate from Syncthing's default theme assets, so selecting default keeps
Syncthing's styling and any user customization intact.
Click a preview to play the video. These four walkthroughs cover live file activity, folder management, Web UI theming, and plugin settings.
Warning
The Hyprland window to the left of the plugin is not part of the plugin. It
live-tracks changes in the test-source directory for the demonstration.
File activity Copy and remove files while the panel reports live synchronization activity. |
Folder lifecycle Unlink, relink, and forget a folder without deleting its local files. |
Theme-aware Web UI Follow Omarchy theme changes in Syncthing's Web UI without reloading. |
Icon and settings Switch the bar icon style and review the plugin's other settings. |
The plugin reports only state exposed by Syncthing:
- Blue identifies synchronization or an indexed addition.
- Red identifies an indexed entry with
deleted=true. - Green identifies remote download progress, which is an upload from this device.
Syncthing does not expose a reliable source-to-destination relationship for a rename or move, so the plugin does not guess one from nearby additions and deletions.
UNLINK pauses the selected folder and LINK resumes it. Both actions use
Syncthing's reversible paused setting; they do not create filesystem links or
change device sharing.
FORGET is available for an unlinked folder. It removes that folder from the local Syncthing configuration without deleting its directory or data. Its Folder ID, settings, and device list are no longer retained by the plugin.
Adding a folder requires an existing directory and a unique Folder ID. The path is canonicalized, and paths that duplicate, contain, or sit inside another configured folder are rejected. A new folder is local-only unless remote devices are explicitly selected.
Pending unencrypted folder offers can prefill the Folder ID, label, and offering device. Encrypted offers and sharing with untrusted devices must be configured in the Web UI.
A shared folder must use the same Folder ID on every device. Labels and paths may differ. Create the folder on one device, share it, and accept the offer on the other devices rather than creating unrelated folder identities.
See Syncthing's Getting Started guide and folder guide for device pairing and sharing.
Folder management and Web UI theming use Syncthing's granular configuration and system-path APIs and require Syncthing 1.21.0 or later.
Planned work stays at the top. Shipped entries come from CHANGELOG.md, newest first.
| Release | State | Date | What changed |
|---|---|---|---|
| Next | planned | TBD | improve and expand Syncthing Web UI customization |
| prepare broader Quickshell compatibility | |||
| 0.1.6 | shipped | 2026-08-22 | make live and indexed file activity accurate |
| refine folder lifecycle controls and pending offers | |||
| add versioned icon and live Web UI theme settings | |||
| refresh the preview and add four focused demo videos | |||
| 0.1.5 | shipped | 2026-08-20 | add an optional theme-colored bar icon |
| 0.1.4 | shipped | 2026-08-16 | support TLS-enabled local Syncthing APIs |
| 0.1.3 | shipped | 2026-08-15 | add a demo video and improve the documentation |
| 0.1.2 | shipped | 2026-08-15 | manage Syncthing folders from the bar panel |
| 0.1.1 | shipped | 2026-08-14 | monitor installs and show live synchronization activity |
| 0.1.0 | shipped | 2026-08-12 | first release |
Open the plugin settings and select Cleanly remove Syncthing plugin. The confirmation can preserve or delete the plugin settings. Both choices restore Syncthing's default Web UI when the Omarchy theme is active, remove the generated Omarchy theme, and then use Omarchy's native plugin removal.
Clean plugin removal never uninstalls Syncthing or removes its configuration, folders, devices, or synchronized data. Uninstall Syncthing separately only when that is intended:
systemctl --user disable --now syncthing.service
omarchy pkg drop syncthingThese commands do not remove Syncthing configuration or synchronized files.
The plugin talks only to Syncthing's local API. It keeps the API key in memory and does not persist or log it. Like other Omarchy shell plugins, it runs unsandboxed, and the API key permits Syncthing configuration changes.
Plugin code is MIT licensed. Adapted Syncthing status icons are MPL-2.0; their
source and attribution are documented in assets/README.md.