quraniclabs-cli

A simple command-line interface to access the QuranicLabs API directly from the terminal.

Installation

Run the following command on your terminal to install the CLI on your system:

npm install quraniclabs-cli -g

*Installing npm packages requires Node.js on your system.

*Must be ran as administrator to install globally ("sudo npm i quraniclabs-cli -g" on macOS).

View package on npmjs.com

Usage

All commands are based on the following command structure:

ql <command> [query] [flags]

Possible command values:

• verse / v – load verse(s)
• chapter / ch – load a chapter
• search / s – search Quran: The Final Testament
• prayertimes / pt - fetch latest prayer times for any city
• moc – search Dr. Rashad Khalifa's media transcripts
• gv – calculate gematrical value of any Arabic text

Possible flag values:

• -a – include Arabic text
• -t – include Arabic transliteration
• -h false – no headers
• -f false – no footnotes
• --sf – filter strictly for the exact search query
• --strict – filter strictly for text matches (no headers/footnotes)
• --detailed - include additional details if applicable

Examples

Quranic commands

Load a single verse:

ql v 1:2

Output:

[1:2] Praise be to GOD, Lord of the universe.

Load multiple verses:

ql v 1:2-4

Output:

[1:2] Praise be to GOD, Lord of the universe.

[1:3] Most Gracious, Most Merciful.

[1:4] Master of the Day of Judgment.

Search the text:

ql s "nineteen" --strict

Output:

Found 1 verses with "nineteen"

The Quran's Common Denominator

[74:30] Over it is nineteen.±

±74:30-35 This "One of the great miracles" provides the first physical evidence that the Quran is God's message to the world. This 19-based miracle is detailed in Appendix 1.

Media commands

Search Dr. Khalifa's media transcripts:

ql moc "1974"

Output:

Found 3 instances of "1974"

1989 Feb (Sermon) @ 7:00 - https://youtu.be/HO8vezbVKso?t=420s - with that year, 1974.

1989 Feb (Sermon) @ 7:37 - https://youtu.be/HO8vezbVKso?t=457s - that was January 1974.

1989 Feb (Sermon) @ 7:42 - https://youtu.be/HO8vezbVKso?t=462s - And this corresponded to the last month, this is the first month of 1974, corresponds to

Prayer times

Search by city:

ql pt "new york"

Output:

New York City, New York, USA
8:52 PM (Eastern Standard Time)

Schedule
Fajr: 3:43 AM
Dhuhr: 1:03 PM
Asr: 5:00 PM
Maghrib: 8:23 PM
Isha: 10:21 PM
Sunrise: 5:41 AM

Upcoming
Isha (in 1h 29m)

Other commands

Random verse:

ql rv

Random chapter:

ql rc

Gematrical value:

ql gv "[arabic text]"

License

The quraniclabs-cli is licensed under the MIT license.