https://github.com/sarfraznawaz2005/quran-cli

:closed_book: Read/Recite The Holy Quran from the commandline with English translation.
https://github.com/sarfraznawaz2005/quran-cli

cli holy islam islamic-apps javascript node nodejs quran

Last synced: 27 days ago
JSON representation

:closed_book: Read/Recite The Holy Quran from the commandline with English translation.

• Host: GitHub
• URL: https://github.com/sarfraznawaz2005/quran-cli
• Owner: sarfraznawaz2005
• License: mit
• Created: 2018-02-19T12:50:37.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-05-02T05:11:27.000Z (about 2 years ago)
• Last Synced: 2024-02-24T23:34:32.397Z (4 months ago)
• Topics: cli, holy, islam, islamic-apps, javascript, node, nodejs, quran
• Language: JavaScript
• Homepage:
• Size: 953 KB
• Stars: 100
• Watchers: 9
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-Islam - Quran-CLI

README

        
# :closed_book: quran-cli

Read/Recite The Holy Quran from the commandline with English translation.

# Requirements

- [NodeJS](http://nodejs.org)

# Installation

- Clone this repository. `git clone https://github.com/sarfraznawaz2005/quran-cli.git`

- Type `npm install`

- Type `npm link`

# Usage

**List All Chapters**

`quran chapters` or with alias `quran c`

![Screenshot](https://raw.githubusercontent.com/sarfraznawaz2005/quran-cli/master/chapters.png)

**Read Specific Chapter**

Command format is: `read|r  [verse] [arabic]` where `verse` and `arabic` arguments are optional.

To read 1st chapter:

`quran read 1` or with alias `quran r 1`

![Screenshot](https://raw.githubusercontent.com/sarfraznawaz2005/quran-cli/master/screen1.png)

***English Only***: To read 1st chapter for example, type: `quran read 1 0 0`. Here first `0` means no/all verses and second `0` means no Arabic text.

![Screenshot](https://raw.githubusercontent.com/sarfraznawaz2005/quran-cli/master/screen6.png)

**Read Specific Verse from a Chapter**

To read 2nd verse from 2nd chapter:

`quran read 2 2` or with alias `quran r 2 2`

![Chapters](https://raw.githubusercontent.com/sarfraznawaz2005/quran-cli/master/screen2.png)

***English Only***: To read 25th verse of chapter 3 for example, type: `quran read 3 25 0`. Here `0` means no Arabic text.

![Screenshot](https://raw.githubusercontent.com/sarfraznawaz2005/quran-cli/master/screen5.png)

**Read Specified Range of Verses from a Chapter**

To read verses from 1 to 5 from 12th chapter:

`quran read 12 1:5` or with alias `quran r 12 1:5`

![Screenshot](https://raw.githubusercontent.com/sarfraznawaz2005/quran-cli/master/screen3.png)

**Search in Translation**

To search for word `book` for example:

`quran search book` or with alias `quran s book`

![Screenshot](https://raw.githubusercontent.com/sarfraznawaz2005/quran-cli/master/screen7.png)

***English Only***: Specify second arguments as `0` to hide arabic text: `quran search book 0`

**Note**: If search results are too much, they might not fit into cli buffer, in such case you can save search results to text file instead like here we search for word `Allah` to save into text file: `quran search Allah > filename.txt`

**Get Information about a Chapter**

`quran info 12` or with alias `quran i 12`

![Screenshot](https://raw.githubusercontent.com/sarfraznawaz2005/quran-cli/master/screen4.png)

**Get Help Information**

`quran --help`

## Similar Projects

- [The Holy Quran](https://github.com/sarfraznawaz2005/holy-quran)

- [Quran Browser Extension](https://github.com/sarfraznawaz2005/quran-browser-extension)

# License

This project is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)