{"id":13612240,"url":"https://github.com/sarfraznawaz2005/quran-cli","last_synced_at":"2025-03-16T13:31:37.138Z","repository":{"id":29564272,"uuid":"122061754","full_name":"sarfraznawaz2005/quran-cli","owner":"sarfraznawaz2005","description":":closed_book: Read/Recite The Holy Quran from the commandline with English translation.","archived":false,"fork":false,"pushed_at":"2022-05-02T05:11:27.000Z","size":976,"stargazers_count":115,"open_issues_count":0,"forks_count":10,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-03-16T02:47:39.381Z","etag":null,"topics":["cli","holy","islam","islamic-apps","javascript","node","nodejs","quran"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sarfraznawaz2005.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-02-19T12:50:37.000Z","updated_at":"2025-03-03T11:17:05.000Z","dependencies_parsed_at":"2022-07-27T20:19:55.235Z","dependency_job_id":null,"html_url":"https://github.com/sarfraznawaz2005/quran-cli","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sarfraznawaz2005%2Fquran-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sarfraznawaz2005%2Fquran-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sarfraznawaz2005%2Fquran-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sarfraznawaz2005%2Fquran-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sarfraznawaz2005","download_url":"https://codeload.github.com/sarfraznawaz2005/quran-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243875180,"owners_count":20361966,"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","holy","islam","islamic-apps","javascript","node","nodejs","quran"],"created_at":"2024-08-01T20:00:25.453Z","updated_at":"2025-03-16T13:31:36.610Z","avatar_url":"https://github.com/sarfraznawaz2005.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","Quranic Text and Reading (386 projects)","Open Source Projects"],"sub_categories":["JavaScript","APIs \u0026 Libraries"],"readme":"# :closed_book: quran-cli\n\nRead/Recite The Holy Quran from the commandline with English translation.\n\n# Requirements\n\n- [NodeJS](http://nodejs.org)\n\n# Installation\n\n- Clone this repository. `git clone https://github.com/sarfraznawaz2005/quran-cli.git`\n- Type `npm install`\n- Type `npm link`\n\n# Usage\n\n**List All Chapters**\n\n`quran chapters` or with alias `quran c`\n\n![Screenshot](https://raw.githubusercontent.com/sarfraznawaz2005/quran-cli/master/chapters.png)\n\n**Read Specific Chapter**\n\nCommand format is: `read|r \u003cchapter\u003e [verse] [arabic]` where `verse` and `arabic` arguments are optional.\n\nTo read 1st chapter:\n\n`quran read 1` or with alias `quran r 1`\n\n![Screenshot](https://raw.githubusercontent.com/sarfraznawaz2005/quran-cli/master/screen1.png)\n\n***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.\n\n![Screenshot](https://raw.githubusercontent.com/sarfraznawaz2005/quran-cli/master/screen6.png)\n\n**Read Specific Verse from a Chapter**\n\nTo read 2nd verse from 2nd chapter:\n\n`quran read 2 2` or with alias `quran r 2 2`\n\n![Chapters](https://raw.githubusercontent.com/sarfraznawaz2005/quran-cli/master/screen2.png)\n\n***English Only***: To read 25th verse of chapter 3 for example, type: `quran read 3 25 0`. Here `0` means no Arabic text.\n\n![Screenshot](https://raw.githubusercontent.com/sarfraznawaz2005/quran-cli/master/screen5.png)\n\n**Read Specified Range of Verses from a Chapter**\n\nTo read verses from 1 to 5 from 12th chapter:\n\n`quran read 12 1:5` or with alias `quran r 12 1:5`\n\n![Screenshot](https://raw.githubusercontent.com/sarfraznawaz2005/quran-cli/master/screen3.png)\n\n**Search in Translation**\n\nTo search for word `book` for example:\n\n`quran search book` or with alias `quran s book`\n\n![Screenshot](https://raw.githubusercontent.com/sarfraznawaz2005/quran-cli/master/screen7.png)\n\n***English Only***: Specify second arguments as `0` to hide arabic text: `quran search book 0`\n\n**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 \u003e filename.txt`\n\n**Get Information about a Chapter**\n\n`quran info 12` or with alias `quran i 12`\n\n![Screenshot](https://raw.githubusercontent.com/sarfraznawaz2005/quran-cli/master/screen4.png)\n\n**Get Help Information**\n\n`quran --help`\n\n\n## Similar Projects\n\n- [The Holy Quran](https://github.com/sarfraznawaz2005/holy-quran)\n- [Quran Browser Extension](https://github.com/sarfraznawaz2005/quran-browser-extension)\n\n# License\n\nThis project is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsarfraznawaz2005%2Fquran-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsarfraznawaz2005%2Fquran-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsarfraznawaz2005%2Fquran-cli/lists"}