1.2.1

Changes

You can pass the --index flag to the search command to output verses along with their indexes.

Examples

echo وَلا تضرونه ش | quran search --index --limit 1

The above command will return this result:

 - result:
    chapter: 11
    number: 57
    text: فإن [0] تولوا [1] فقد [2] أبلغتكم [3] ما [4] أرسلت [5] به [6] إليكم [7] ويستخلف [8] ربي [9] قوما [10] غيركم [11] ولا [12] تضرونه [13] شيئا [14] إن [15] ربي [16] على [17] كل [18] شيء [19] حفيظ [20]
    translation: 'But if they turn away, [say], "I have already conveyed that with which I was sent to you. My Lord will give succession to a people other than you, and you will not harm Him at all. Indeed my Lord is, over all things, Guardian'
  score: 77

Installation

To install the Quran CLI on Linux, run the following command:

curl -L -o /tmp/quran https://github.com/yojoecapital/quran-cli/releases/latest/download/quran && chmod 755 /tmp/quran && sudo mv /tmp/quran /usr/local/bin/

This will download and install the executable to /usr/local/bin/, making it accessible from anywhere in your terminal.

1.2.0

Changes

• the <selection> argument gives a couple more ways of selecting. This can be used in the verse command, in notes, or in searches
  • select by pages by using p<number>
  • select by Juz by using j<number>
• the search command has some new features too
  • search by translation by passing the --translation flag
  • filter your search to a particular spot by passing a selection option like --selection <selection>
• search your notes' text with note search

Examples

Using pages in selections

quran verse p1
# returns all the verses on page 1
quran verse p1..p3
# returns all the verses between pages 1 and 3
quran verse p600..
# returns all the verses from page 600 to the end (604)
quran verse j1
# returns all the verses in Juz 1
quran verse j1..j2
# returns all the verses between Juz 1 and 2
quran verse p10..j2
# returns all the verses between page 10 and Juz 2

Searching

Both of these commands will return this verse:

- result:
    chapter: 2
    number: 156
    text: الذين إذا أصابتهم مصيبة قالوا إنا لله وإنا إليه راجعون
    translation: 'Who, when disaster strikes them, say, "Indeed we belong to Allah, and indeed to Him we will return'
  score: 82

By translation

quran search Those who when disaster strikes, they say Indeed we belong to Allah and we will return to Him! --translation --limit 1

Filtering by selection

# note that you can also pipe input to the 'search' command
echo انا لله وانا اليه راجعون| quran search --selection al-baqara --limit 1

Installation

To install the Quran CLI on Linux, run the following command:

curl -L -o /tmp/quran https://github.com/yojoecapital/quran-cli/releases/latest/download/quran && chmod 755 /tmp/quran && sudo mv /tmp/quran /usr/local/bin/

This will download and install the executable to /usr/local/bin/, making it accessible from anywhere in your terminal.

1.1.0

Changes

• notes are a bit more strict with how they handle references
• there are 2 kinds of references the user can make in a note:
  • a macro like {<selection>} which will expand to the selected verses when the note renders
  • or a tag like #<selection> which will display the name of the selection
• notes must include at least one reference. To force a note with no references to be made, use --force
• note list now can take the option --by to filter your input selection by either macro, tag, or both
• you can use note get to get notes by their IDs

Examples

References being used in a note

# This is an example note

- this is an *example* of a tag: #al-mulk
- this renders to #[Al-Mulk]
- this is an *example* of a selection: {67:30}
- this renders to قل أرأيتم إن أصبح ماؤكم غورا فمن يأتيكم بماء معين

Using note list

quran note list
# this will list all the notes that have macro references (--by has a default of macro)
quran note list --by both
# this will list all the notes
quran note list --by tag
# this will list all the notes that have tags
quran note list al-baqara --by tag
# this will list all the notes that have tags in Al-Baqara

Database Download

The Quran CLI will download a pre-built database to ~/.config/quran-cli/data.db. You can also access the database at https://yojoecapital.github.io/quran-cli/.

Installation

To install the Quran CLI on Linux, run the following command:

curl -L -o /tmp/quran https://github.com/yojoecapital/quran-cli/releases/latest/download/quran && chmod 755 /tmp/quran && sudo mv /tmp/quran /usr/local/bin/

This will download and install the executable to /usr/local/bin/, making it accessible from anywhere in your terminal.

1.0.0

I'm excited to announce the official release of the Quran CLI. This version is stable and ready for use, أنشاء الله. It brings key features for interacting with the Quran and managing notes related to specific verses or chapters.

Features

• verse <selection>: display a verse or range of verses from the Quran
• chapter <selection>: output information for a chapter or range of chapters from the Quran
• search <query>: search for a verse from the Quran
• note [command]: you can create and manage notes
  • these notes are indexed based on what verses you reference
  • you can reference verses with expansions like {<selection>} (which will expand to the selected verse or chapter) or hashtags like #<selection>
  • you can then filter on these references to quickly scan your notes
  • notes use basic markdown syntax and console output is color-coded accordingly
  • for more help on notes, use the --help flag

Database Download

The Quran CLI will download a pre-built database to ~/.config/quran-cli/data.db. You can also access the database at https://yojoecapital.github.io/quran-cli/.

Installation

To install the Quran CLI on Linux, run the following command:

curl -L -o /tmp/quran https://github.com/yojoecapital/quran-cli/releases/latest/download/quran && chmod 755 /tmp/quran && sudo mv /tmp/quran /usr/local/bin/

This will download and install the executable to /usr/local/bin/, making it accessible from anywhere in your terminal.

1.0.0-beta

This is a pre-release version of the Quran CLI. It is still in beta, but functional and ready for use.

Features

• verse <selection>: display a verse or range of verses from the Quran
• chapter <selection>: output information for a chapter or range of chapters from the Quran
• search <query>: search for a verse from the Quran
• note [command]: you can now create and manage notes
  • these notes are indexed based on what verses you reference
  • you can reference verses with expansions like {<selection>} (which will expand to the selected verse or chapter) or hashtags like #<selection>
  • you can then filter on these references to quickly scan your notes
  • notes use basic markdown syntax and console output is color-coded accordingly
  • for more help on notes, use the --help flag

The Quran CLI downloads a pre-built database to ~/.config/quran-cli/data.db, available at https://yojoecapital.github.io/quran-cli/.

Installation

curl -L -o /tmp/quran https://github.com/yojoecapital/quran-cli/releases/download/1.0.0-beta/quran && chmod 755 /tmp/quran && sudo mv /tmp/quran /usr/local/bin/

0.0.1-beta

This is a pre-release version of the Quran CLI. This is it's first iteration and everything is subject to change. This version will not work with the current database schema. You'll have to run build-db.

Installation

curl -L -o /tmp/quran https://github.com/yojoecapital/quran-cli/releases/download/0.0.1-beta/quran && chmod 755 /tmp/quran && sudo mv /tmp/quran /usr/local/bin/