ahmedsaheed / qurancli

Command line tool to read, search and recite the Quran.

Quran CLI

Read, Search and Recite the Quran from your terminal.

Screen.Recording.2023-08-06.at.10.55.59.mov

Examples

qurancli -s 1 # Read surah Al-Fatiha in arabic
qurancli -s 1 -t # Read surah Al-Fatiha in english
qurancli -s 1 -a # Play Al-Fatiha Audio
qurancli -s 1 -at # Play Al-Fatiha Audio in english
qurancli -q "Mohammed" # Search any word in the quran

Commands

Command	Usage
-s, --surah-number=surahNumber	find a surah by it's number in range 1 -> 114
-a, --audio	Plays audio version of surah
-at, --AudioTranslation	Translate surah to english and play audio
-q, --query=queryString	Search a keyword from the quran
-t, --translation	Translate a selected surah to english
-V, --version	Print version information and exit.

Install

MacOS and Linux

Install using Homebrew

brew tap ahmedsaheed/qurancli
brew install qurancli

# or

brew install ahmedsaheed/tap/qurancli

Update & Uninstall

Update

brew upgrade qurancli

Uninstall

brew uninstall qurancli -f

Windows

Install Using Scoop

Step 1: Install Java & Specify the JAVA_HOME path

scoop bucket add java
scoop install openjdk

# AND

scoop bucket add extras
scoop install find-java

Step 2: Install the application

scoop bucket add ahmedsaheed https://github.com/ahmedsaheed/scoop-ahmedsaheed.git
scoop install qurancli

Build

git clone https://github.com/ahmedsaheed/quranCL

cd quranCLI

java -jar /path/to/quranCLI-1.0.jar [args]

#Or
#On unix-based operating systems, you can define an alias in bashrc. For example:

alias qurancli='java -cp "/path/to/quranCLI-1.0.jar" qurancli'

qurancli -s -1

_{Copyright(c) quranCLI 2022}

_{This application requires a terminal which support bi-directional text}