---
## ๐ What is Sunnah?
`sunnah` is an interactive CLI package manager for the major hadith collections of Islam. Install, manage, and update every book in the Sunnah ecosystem from a single terminal command โ for both **npm** (Node.js/React) and **pip** (Python).
```bash
npm install -g sunnah # Node.js CLI
pip install sunnah # Python CLI
sunnah # open interactive TUI
```
---
## ๐ฆ Available Packages
| Book | npm | pip | Hadiths | CLI |
|------|-----|-----|---------|-----|
| **Sahih al-Bukhari** | `sahih-al-bukhari` | `sahih-al-bukhari` | 7,563 | `bukhari` |
| **Sahih Muslim** | `sahih-muslim` | `sahih-muslim` | 7,470 | `muslim` |
| **Sunan Abi Dawud** | `sunan-abi-dawud` | `sunan-abi-dawud` | 5,274 | `dawud` |
| **Jami al-Tirmidhi** | `jami-al-tirmidhi` | `jami-al-tirmidhi` | 3,956 | `tirmidhi` |
| **Sunan Ibn Majah** | `sunan-ibn-majah` | `sunan-ibn-majah` | 4,341 | `majah` |
| **Sunan al-Nasa'i** | `sunan-al-nasai` | `sunan-al-nasai` | 5,768 | `nasai` |
---
## ๐ Installation
```bash
# JavaScript / Node.js
npm install -g sunnah
# Python
pip install sunnah
```
---
## ๐ฅ๏ธ Interactive TUI
```bash
sunnah
```
Opens a full-screen terminal UI. Navigate with `โโ`, toggle with `space`, press `enter` to install.
```
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
๐ฟ Sunnah Package Manager v1.5.0
โโ nav space select a all i info u uninstall U update enter install q quit
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โถ [โ] Sahih al-Bukhari โ npm (up to date)
Imam Muhammad ibn Ismail al-Bukhari
Most authentic hadith collection, second only to the Quran.
Hadiths: 7,563 CLI: bukhari --help npm: sahih-al-bukhari pip: sahih-al-bukhari
[ ] Sahih Muslim โ not installed
[ ] Sunan Abi Dawud โ not installed
...
```
### Keyboard Controls
| Key | Action |
|-----|--------|
| `โ` `โ` | Navigate |
| `space` | Toggle select |
| `a` | Select all / deselect all |
| `i` | Show package info |
| `u` | Uninstall selected |
| `U` | Update selected |
| `enter` | Install selected |
| `q` | Quit |
---
## โก Commands
### npm packages
```bash
sunnah list # all packages + npm/pip status
sunnah install bukhari # npm install -g sahih-al-bukhari
sunnah install bukhari nasai majah # install multiple at once
sunnah uninstall dawud # uninstall
sunnah update # check for updates
sunnah update --install # auto-install all updates
```
### Python (pip) packages
```bash
sunnah pip install bukhari # pip install sahih-al-bukhari
sunnah pip install bukhari nasai # install multiple
sunnah pip uninstall dawud # uninstall
sunnah pip list # show Python package status
sunnah pip update # check for pip updates
sunnah pip update --install # auto-install pip updates
```
### ๐ NEW: Cross-book search
```bash
sunnah search "prayer" # search all installed books (top 3 each)
sunnah search "fasting" --all # show all results
```
### ๐ฒ NEW: Random hadith
```bash
sunnah random # random hadith from a random installed book
sunnah random bukhari # random hadith specifically from Bukhari
```
### โน๏ธ NEW: Book info
```bash
sunnah info nasai # detailed info: versions, CLI, Python import
sunnah info jami-al-tirmidhi # works with full npm name too
```
### โ๏ธ React hook generator
```bash
sunnah --react # generate useSunnah() for all installed books
sunnah --react bukhari muslim # specific books only
```
---
## ๐ Python API
After `pip install sunnah`, you also get the individual book packages:
```bash
sunnah pip install bukhari muslim nasai
```
```python
from sahih_al_bukhari import Bukhari
from sahih_muslim import Muslim
from sunan_al_nasai import Nasai
bukhari = Bukhari()
bukhari.get(1)
bukhari.search("prayer", limit=5)
bukhari.getRandom()
bukhari.getByChapter(1)
```
---
## ๐จ JavaScript / Node.js
```bash
sunnah install bukhari muslim
```
```javascript
import bukhari from 'sahih-al-bukhari';
import muslim from 'sahih-muslim';
bukhari.get(1).english.text
muslim.search('prayer', 5)
```
---
## ๐ Version Stats
```bash
sunnah --version
```
```
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
๐ฟ sunnah v1.5.0
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Available : 6
npm inst. : 4 / 6
pip inst. : 3 / 6
Collection : Sahih al-Bukhari, Sahih Muslim, Sunan al-Nasa'i, Jami al-Tirmidhi
Hadiths : 24,257
```
---
## ๐๏ธ Monorepo Structure
```
sunnah/
โโโ bin/index.js โ npm CLI (interactive TUI + all commands)
โโโ python/sunnah_cli/ โ Python CLI (mirrors npm CLI exactly)
โ โโโ __init__.py
โ โโโ cli.py โ main Python CLI entry
โ โโโ packages.py โ package registry (single source of truth)
โ โโโ npm_utils.py โ npm helpers
โ โโโ pip_utils.py โ pip helpers
โโโ package.json
โโโ pyproject.toml
โโโ .github/workflows/ โ auto-publish to npm + PyPI on release
```
---
## ๐ License
GNU Affero General Public License v3.0 (AGPL-3.0)
---
**Made with โค๏ธ for the Muslim community ยท Seeking knowledge together**
[](https://github.com/SENODROOM/sunnah)
[๐ฆ npm](https://npmjs.com/package/sunnah) โข [๐ PyPI](https://pypi.org/project/sunnah/) โข [๐ Issues](https://github.com/SENODROOM/sunnah/issues)
sunnah
