quran-cli

Read the Holy Quran from your terminal.

Installation

$ go install github.com/vanillaiice/quran-cli@latest

Demo

quran-cli-demo.mp4

Example Usage

# read the first surah of the Quran in english with arabic text
$ quran-cli read

# read a random surah in english
$ quran-cli read --random

# read surah #55 in french translation only
$ quran-cli read --language fr --number 55 --mode tr

# initialize data for chinese
$ quran-cli init -l zh

# read surah Al-Mulk in chinese
$ quran-cli read -l zh -s mulk

if data for a language is not initialized, it can be initialized automatically by answering to the shown prompt.

By default, the data is stored in the $HOME/.quran-cli directory.

Help

NAME:
   quran-cli - Read the Holy Quran from your terminal

USAGE:
   quran-cli [global options] command [command options]

VERSION:
   0.1.0

AUTHOR:
   vanillaiice <vanillaiice1@proton.me>

COMMANDS:
   init, i  initialize data for a language
   read, r  read a surah
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --log-level value, -g value  set log level (default: "info")
   --help, -h                   show help
   --version, -v                print the version

Misc

• Please make sure to have the proper arabic fonts installed on your system (if you plan to read in arabic).
• If the terminal screen is too small, some of the text might not be displayed correctly.

Todo

• Add more styling to the current display.

Acknowledgements

• The Quran JSON files are sourced from risan/quran-json, which are in turn taken from tanzil.net
• The different terminal UI styles use tview, and termenv.

License

This project is licensed under the GPLv3 License.

Author

vanillaiice