{"id":21327625,"url":"https://github.com/mostafa-wael/quran-cli","last_synced_at":"2025-07-12T07:31:36.250Z","repository":{"id":46333291,"uuid":"511410237","full_name":"Mostafa-wael/Quran-cli","owner":"Mostafa-wael","description":"A simple command line interface for listening to Quran.","archived":false,"fork":false,"pushed_at":"2023-09-29T00:47:25.000Z","size":32064,"stargazers_count":88,"open_issues_count":7,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-07-06T16:43:22.120Z","etag":null,"topics":["cli","mpv","quran","radio","reciter"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@quran-cli/q-cli","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Mostafa-wael.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-07-07T06:30:26.000Z","updated_at":"2025-05-06T11:27:57.000Z","dependencies_parsed_at":"2024-10-31T03:02:53.248Z","dependency_job_id":"77e9b827-8470-4fce-a777-1b87c9bfa188","html_url":"https://github.com/Mostafa-wael/Quran-cli","commit_stats":{"total_commits":84,"total_committers":7,"mean_commits":12.0,"dds":"0.34523809523809523","last_synced_commit":"af9e51cdaf2b2d343b447d49b7889ad1c69d9238"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/Mostafa-wael/Quran-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mostafa-wael%2FQuran-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mostafa-wael%2FQuran-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mostafa-wael%2FQuran-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mostafa-wael%2FQuran-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Mostafa-wael","download_url":"https://codeload.github.com/Mostafa-wael/Quran-cli/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mostafa-wael%2FQuran-cli/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264958135,"owners_count":23689006,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","mpv","quran","radio","reciter"],"created_at":"2024-11-21T21:18:35.040Z","updated_at":"2025-07-12T07:31:31.285Z","avatar_url":"https://github.com/Mostafa-wael.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Quran-CLI\nA simple command line interface for listening to Quran.\n\n\u003cdiv align=\"center\"\u003e\n  \n[![GitHub contributors](https://img.shields.io/github/contributors/Mostafa-wael/Quran-cli)](https://img.shields.io/github/contributors/Mostafa-wael/Quran-cli)\n[![GitHub issues](https://img.shields.io/github/issues/Mostafa-wael/Quran-cli)](https://github.com/Mostafa-wael/Quran-cli/issues)\n[![GitHub forks](https://img.shields.io/github/forks/Mostafa-wael/Quran-cli)](https://github.com/Mostafa-wael/Quran-cli/network)\n[![GitHub stars](https://img.shields.io/github/stars/Mostafa-wael/Quran-cli)](https://github.com/Mostafa-wael/Quran-cli/stargazers)\n[![GitHub license](https://img.shields.io/github/license/Mostafa-wael/Quran-cli)](https://github.com/Mostafa-wael/Quran-cli/blob/master/LICENSE)\n\u003cimg src=\"https://img.shields.io/github/languages/top/Mostafa-wael/Quran-cli\"\u003e \n\n  \n\u003c/div\u003e\n\n## Demo\nhttps://user-images.githubusercontent.com/56788883/181006153-f1d41833-fc60-43e0-9547-5b9660c1c07a.mp4\n\n## Used API\n- We are using the [mp3quran](https://mp3quran.net/eng/api) api.\n## Dependencies\n- Install **mpv** as it is required for playing the audio.\n  - Debian based distributions\n`sudo add-apt-repository ppa:mc3man/mpv-tests`\n`sudo apt update \u0026\u0026 sudo apt install mpv`\n  - [Update] For Ubuntu 22.04\n`sudo apt install mpv`\n  - Windows\n[Follow This link](https://mpv.io/installation/#:~:text=master%20is%20recommended.-,Windows,-All%20binary%20packages)\n\n\n## How to use\n- To use without installing the package: `npx @quran-cli/q-cli [options]`\n- Or install it globally: `sudo npm install  @quran-cli/q-cli -g` and use it as `q-cli [options]`\n- To show the version: `q-cli -v`\n- To show help: `q-cli -h`\n```\nQuran-CLI\n\n  Listen to the Quran from your terminal \n  While listening press P to toggle between pause and resume                    \n  Press q to exit  \n\nOptions\n\n  -n, --showRadios              Shows all available radio channels                                            \n  -d, --radio number            Play specific radio                                                           \n  -c, --reciterSurah number[]   lay specific surah by a specific reciter.                                     \n                                If no surah specified, it will shows the available suras for the specified    \n                                reciter.                                                                      \n  -r, --showReciters            Shows all available reciters                                                  \n  -s, --showSuras               Show all suras in the Quran                                                   \n  -v, --version                 Shows the current version                                                     \n  -h, --help                    Prints this usage guide                                                       \n\n^_^\n\n  Recall us in your doa'!  \n```\n- Show all available radio channels: `q-cli -n`\n- Play specific radio: `q-cli -d \u003cradio index\u003e`\n- Show all available reciters: `q-cli -r`\n- Play specific surah by a specific reciter: `q-cli -c \u003creciter index\u003e  \u003csurah index\u003e`\n- Show all available suras by a specific reciter : `q-cli -c \u003creciter index\u003e`\n- Show all suras in the Quran: `q-cli -s`\n\n## Suggestions\n- Try: `q-cli -d 0`\n\n## How to build locally\n- Install typescript using: `npm install -g typescript` if you do not have typescript globally\n- Install dependencies: `npm install`\n- Build the source files: `npm run build`\n- Run the index: `node bin/index.js [options]`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmostafa-wael%2Fquran-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmostafa-wael%2Fquran-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmostafa-wael%2Fquran-cli/lists"}