Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mostafa-wael/quran-cli
A simple command line interface for listening to Quran.
https://github.com/mostafa-wael/quran-cli
cli mpv quran radio reciter
Last synced: about 1 month ago
JSON representation
A simple command line interface for listening to Quran.
- Host: GitHub
- URL: https://github.com/mostafa-wael/quran-cli
- Owner: Mostafa-wael
- Created: 2022-07-07T06:30:26.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-09-29T00:47:25.000Z (about 1 year ago)
- Last Synced: 2024-10-17T06:46:14.685Z (2 months ago)
- Topics: cli, mpv, quran, radio, reciter
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@quran-cli/q-cli
- Size: 30.6 MB
- Stars: 86
- Watchers: 3
- Forks: 2
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Quran-CLI
A simple command line interface for listening to Quran.
[](https://img.shields.io/github/contributors/Mostafa-wael/Quran-cli)
[](https://github.com/Mostafa-wael/Quran-cli/issues)
[](https://github.com/Mostafa-wael/Quran-cli/network)
[](https://github.com/Mostafa-wael/Quran-cli/stargazers)
[](https://github.com/Mostafa-wael/Quran-cli/blob/master/LICENSE)
## Demo
https://user-images.githubusercontent.com/56788883/181006153-f1d41833-fc60-43e0-9547-5b9660c1c07a.mp4
## Used API
- We are using the [mp3quran](https://mp3quran.net/eng/api) api.
## Dependencies
- Install **mpv** as it is required for playing the audio.
- Debian based distributions
`sudo add-apt-repository ppa:mc3man/mpv-tests`
`sudo apt update && sudo apt install mpv`
- [Update] For Ubuntu 22.04
`sudo apt install mpv`
- Windows
[Follow This link](https://mpv.io/installation/#:~:text=master%20is%20recommended.-,Windows,-All%20binary%20packages)
## How to use
- To use without installing the package: `npx @quran-cli/q-cli [options]`
- Or install it globally: `sudo npm install @quran-cli/q-cli -g` and use it as `q-cli [options]`
- To show the version: `q-cli -v`
- To show help: `q-cli -h`
```
Quran-CLI
Listen to the Quran from your terminal
While listening press P to toggle between pause and resume
Press q to exit
Options
-n, --showRadios Shows all available radio channels
-d, --radio number Play specific radio
-c, --reciterSurah number[] lay specific surah by a specific reciter.
If no surah specified, it will shows the available suras for the specified
reciter.
-r, --showReciters Shows all available reciters
-s, --showSuras Show all suras in the Quran
-v, --version Shows the current version
-h, --help Prints this usage guide
^_^
Recall us in your doa'!
```
- Show all available radio channels: `q-cli -n`
- Play specific radio: `q-cli -d `
- Show all available reciters: `q-cli -r`
- Play specific surah by a specific reciter: `q-cli -c `
- Show all available suras by a specific reciter : `q-cli -c `
- Show all suras in the Quran: `q-cli -s`
## Suggestions
- Try: `q-cli -d 0`
## How to build locally
- Install typescript using: `npm install -g typescript` if you do not have typescript globally
- Install dependencies: `npm install`
- Build the source files: `npm run build`
- Run the index: `node bin/index.js [options]`