Omahub
← All plugins
A

Hadith

by abdalrohman

Authentic Prophetic Hadiths from 10 major collections (36,000+ hadiths), daily Hadith of the day, bookmarks, search, and scheduled desktop notifications

GitHub

Security review

Review recommended · 1 finding

Deterministic scan — not a security guarantee

Low
Risk level
Low
Analyzed commit
a60713f
Scanned
1 month ago

Flagged patterns appear only in documentation files (README / docs) — descriptive examples, not executable code.

  • Docs external_hosts README.md:108

    Downloads or connects to an external HTTP(S) host.

    git clone https://github.com/abdalrohman/omarchy-hadith.git ~/.config/omarchy/plugins/abdulrahman.hadith

Automated analysis only — not a security guarantee.

AI advisory review

No obvious issues detected

Language-model assessment · ~deepseek/deepseek-v4-flash-latest — advisory only

Low
AI risk level
Low
Recommendation
install
Model
~deepseek/deepseek-v4-flash-latest
Analyzed commit
a60713f
Reviewed
1 month ago

The plugin is a benign desktop widget that displays hadiths from bundled data, with no network access or dangerous operations. The only flagged item is a git clone URL in the README, which is installation documentation and not executed by the plugin.

  • The deterministic scan flagged an external host in README.md, but this is just a git clone command for manual installation and poses no runtime risk.
How this check works

This review combines the deterministic scan (the rule-based results above) with an independent look at the plugin's code by a language model. The model reads a trimmed sample of the repository's files, the manifest, and the README, then gives a plain-language risk level and a recommendation: install (no notable danger), review (look closer first), or avoid (clearly dangerous).

It runs on the same analyzed commit as the deterministic scan and is strictly advisory — it is not a security guarantee and never blocks a plugin by itself. A human moderator still reviews plugins before they are listed.

AI advisory only — automated analysis, not a security guarantee.

Install
$ omarchy plugin add https://github.com/abdalrohman/omarchy-hadith --enable
Widgets #bar #quickshell

Omarchy Hadith Plugin (abdulrahman.hadith)

Omarchy Plugin Author License: MIT Version UmmahAPI

A native, elegant Prophetic Hadith reader, daily wisdom reminder & 10-collection explorer for the Omarchy Desktop (Quickshell). Integrates the complete UmmahAPI Hadith catalog covering 10 major collections and 36,000+ authentic Hadiths, daily Hadith of the Day scheduling, bookmarks, and a multi-action status bar widget.

Developed by @abdalrohman.

<p align="center"> <img src="assets/screenshot_reader.png" width="80%" alt="Hadith Reader & Daily Wisdom" /> </p> <p align="center"> <img src="assets/screenshot_collections.png" width="80%" alt="10 Major Hadith Collections & Live Search" /> </p> <p align="center"> <img src="assets/screenshot_settings.png" width="80%" alt="Notifications & Preferences" /> </p>

✨ Features

📜 Menubar Widget (BarWidget.qml)

  • Real-Time Display: Positioned in the active bar with Islamic Scroll glyph (📜), showing current Hadith collection and number, short Arabic excerpt, or countdown timer.
  • Multi-Action Interactions:
    • Left-Click: Open and toggle the detailed popup panel.
    • Middle-Click: Fetch a fresh random Hadith directly from the bar.
    • Right-Click: Cycle through widget display formats.
    • Scroll Wheel: Quick navigate between Previous / Next Hadiths.
  • Multiple Display Formats (Right-Click to cycle):
    1. [Icon] only (Default)
    2. [Icon] Collection #Number (e.g. 📜 Sahih al-Bukhari #1)
    3. [Icon] Excerpt (e.g. 📜 إنما الأعمال بالنيات…)
    4. [Icon] Next in Xh (e.g. 📜 3h 45m)

📖 Popup Details Panel (Panel.qml)

1. Active Hadith Reader

  • Calligraphy Display: Clear, high-readability Arabic typography with diacritics (Tashkeel) and customizable font sizing (Normal 20px, Large 24px, XL 28px).
  • English Translation: Accurate English meanings with toggleable display.
  • Authenticity Badges: Collection name, Hadith number, and authenticity grade (Grade: Sahih / Grade: Hasan).
  • Action Toolbar:
    • ⭐ Bookmark: Star and pin Hadiths for future reference.
    • 🔀 Random: Fetch a fresh random Hadith instantly (Spacebar).
    • ◀ / ▶ Navigation: Previous and Next Hadiths.
    • 📋 Copy: Quick copy Arabic text, English translation, and Hadith citation to clipboard.

2. 10 Major Hadith Collections & Live Search

  • Major Collections Supported (36,000+ Hadiths):
    • Sahih al-Bukhari (7,580 hadiths)
    • Sahih Muslim (7,360 hadiths)
    • Sunan Abu Dawud (5,272 hadiths)
    • Jami` at-Tirmidhi (3,926 hadiths)
    • Sunan an-Nasa'i (5,679 hadiths)
    • Sunan Ibn Majah (4,340 hadiths)
    • Muwatta Malik (1,829 hadiths)
    • Nawawi's 40 Hadith (42 hadiths)
    • 40 Hadith Qudsi (40 hadiths)
    • Shah Waliullah's 40 Hadith (40 hadiths)
  • 100% Offline-First Core Dataset: Bundled locally with all 42 Nawawi Hadiths, 40 Hadith Qudsi, and foundational Sahih Bukhari/Muslim traditions for instant zero-latency access.
  • Live Search: Search in real time across keywords, narrators, topics, and Hadith numbers.

3. Bookmarks & Personal Library

  • Save your favorite Prophetic traditions to your personal bookmarks with 1-click reading or removal.

4. Daily & Periodic Notifications

  • 🌅 Daily Hadith of the Day: Scheduled desktop notification every morning (default: 08:00).
  • ⏳ Periodic Reminder: Configurable intervals (1h, 2h, 4h, 8h, 12h, 24h) with gentle chime audio.

⌨️ Keyboard Shortcuts

Shortcut Action
Space Fetch new random Hadith
N / L Next Hadith
P / H Previous Hadith
B / F Bookmark / Favorite current Hadith
1 Switch to Hadith Reader tab
2 Switch to Collections & Search tab
3 Switch to Bookmarks tab
4 Switch to Settings drawer
Esc Close panel

🛠️ Installation & Activation

Method 1: Via Omarchy CLI (Recommended)

omarchy plugin add https://github.com/abdalrohman/omarchy-hadith --enable

Method 2: Manual Installation

  1. Clone the repository into your Omarchy plugins directory:
git clone https://github.com/abdalrohman/omarchy-hadith.git ~/.config/omarchy/plugins/abdulrahman.hadith
  1. Enable the plugin in your center bar:
omarchy plugin enable abdulrahman.hadith center
  1. Restart your Omarchy shell:
omarchy restart shell

⚙️ Configuration & State Persistence

State and user preferences are automatically saved at:

  • ~/.local/state/omarchy/settings/hadith.json

State loading is strictly bounded at the descriptor level (capped at 64 KiB via head -c 65537). If a state file is oversized or unreadable, the plugin safely falls back to defaults. Writes are atomic and symlink-safe.

📦 Dependencies & System Requirements

  • head (coreutils) from base system (used for descriptor-bounded state reads)
  • python3 (for atomic state writes and clipboard/audio helpers)
  • omarchy-notification-send (from Omarchy desktop)
  • Audio player (pw-play, paplay, mpv, or ffplay) for chime playback

📄 License

Released under the MIT License by @abdalrohman.