Skip to main content

quran-cli

Samin Yaser

1 minute read · Tuesday, November 21, 2023
View on Github

Get the English translation of the verbatim word of Allah, the only God worthy of worship, right in your terminal.

quran-cli
Figure: quran-cli

Project Overview

”quran-cli” allows you to read the translation of Quran (with footnotes) in your terminal. It is written in pure bash and can be used by anyone who has a basic knowledge of the terminal and no internet is required!

quran-cli
Figure: quran-cli

For now only the English translation by Saheeh International is available. I plan to add more translations in the future, insha’Allah.

Installation

curl https://raw.githubusercontent.com/SaminYaser-work/quran-cli/master/install | sh

Current Features

For the usage information, visit the Github Readme.

  • Get full surah or a particular ayah by verse number, or a range of verses
  • Turn on/off footnotes, simple mode
  • Surah information
  • Bookmark ayahs

Developing

Unit tests have been written for the project using BATS and shellcheck is used for linting. Instructions on installing BATS can be found here.


Run the unit tests:

./test/bats/bin/bats test/test.bats