Skip to content

Latest commit

 

History

9 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Omarqui

An Omarchy bar widget for Qui, the self-hosted qBittorrent management dashboard. See aggregate torrent speed and status at a glance, and manage torrents across all your qBittorrent instances without leaving the desktop.

Panel

In the bar

On the desktop

Features

  • Bar chip — aggregate download and/or upload speed across every qBittorrent instance Qui manages (configurable via the barMetric setting), with a tooltip summary
  • Status filters — click "active / downloading / seeding / paused / errored" to filter the list ("active" means torrents currently transferring data, i.e. non-zero download or upload speed)
  • Ratio at a glance — each torrent row shows its share ratio (e.g. 0.82) right next to its size
  • Instance filter — switch between "All" and individual qBittorrent instances
  • Search — filter by torrent name
  • Per-torrent actions — pause, resume, delete (with a two-step confirm to avoid mistakes, and an option to delete the downloaded files too)
  • Add torrent — paste a magnet link or a local .torrent file path, pick the instance and category, optionally start paused

Requirements

  • A running Qui instance
  • A Qui API key (Settings → API Keys in the Qui web UI)

Install

omarchy plugin add https://github.com/marcuspelo/omarqui.git

Setup

  1. Create ~/.config/omarqui/.env with your Qui API key:
    API_KEY=your-qui-api-key
    BASE_URL=http://your-qui-host:7476
    
    Keeping the key in this file (outside the plugin folder) instead of shell.json keeps it out of any config you might sync or share. BASE_URL is optional but recommended: omarchy plugin disable/enable drops the widget's bar-layout entry (including whatever baseUrl was set via the panel or omarchy bar set), so a value in .env is what keeps working across that reset.
  2. Enable the widget and point it at your Qui instance:
    omarchy plugin enable marcuspelo.omarqui
    omarchy bar set marcuspelo.omarqui baseUrl "http://your-qui-host:7476"
    This step is optional if BASE_URL is already set in .env.

Security

The Qui API key never appears in process arguments: every curl call sends it as an HTTP header supplied over the child process's stdin (curl -K - with a header = "X-API-Key: ..." config line), not as a -H argument — so it's invisible to ps/process inspection. ~/.config/omarqui/.env is also set to mode 0600 automatically every time the plugin reads it; you can do this yourself too: chmod 600 ~/.config/omarqui/.env.

Configuration

Available settings (shell.json, or omarchy bar set marcuspelo.omarqui <key> <value>):

Setting Type Default Description
baseUrl string http://localhost:7476 Base URL of your Qui instance (no trailing slash). Falls back to BASE_URL in ~/.config/omarqui/.env when unset.
refreshIntervalSec integer 10 Seconds between background refreshes (5–300)
barMetric enum Download What the bar chip shows: Download, Upload, or Both. Also editable from the in-panel Settings screen.

Keyboard shortcuts

Key Action
r Refresh
esc Close the panel

Remove

omarchy plugin remove marcuspelo.omarqui

License

MIT

About

An Omarchy bar widget for Qui, the self-hosted qBittorrent management dashboard. See aggregate torrent speed and status at a glance, and manage torrents across all your qBittorrent instances without leaving the desktop.

Resources

Stars

2 stars

Watchers

0 watching

Forks

Contributors

Languages