God's Word on the command line
Find a file
2025-12-03 14:07:20 -05:00
scripts Initial commit 2025-11-06 16:22:54 -05:00
src Initial commit 2025-11-06 16:22:54 -05:00
tools Initial commit 2025-11-06 16:22:54 -05:00
.gitignore Initial commit 2025-11-06 16:22:54 -05:00
build.zig Initial commit 2025-11-06 16:22:54 -05:00
build.zig.zon update to master 2025-12-03 14:07:20 -05:00
LICENSE Initial commit 2025-11-06 15:54:28 -05:00
README.md update README 2025-11-06 18:47:41 -05:00

gods-word

God's Word on the command line

Build

zig build generate
zig build --release=fast

Alternatively you can do zig build generate -- bible.txt to specify a file that follows the file format.

Using the Pager

Navigation Keys

Scrolling:

  • j or - Scroll down one line
  • k or - Scroll up one line
  • Ctrl+d or Page Down - Scroll down 10 lines
  • Ctrl+u or Page Up - Scroll up 10 lines
  • g or Home - Jump to the beginning
  • G or End - Jump to the end

Command Mode

Press : to enter command mode, then type one of the following commands:

Jump to Chapter/Verse (within current book):

  • :5 - Jump to chapter 5
  • :3:16 - Jump to chapter 3, verse 16
  • Jumped verses are highlighted on screen

Load New References:

  • :John 3:16 - Load a specific verse
  • :Romans 8:28-39 - Load a verse range
  • :Genesis 1 - Load a chapter
  • :Revelation - Load an entire book
  • :Jn 3:16 - Use abbreviations (Mt, Rom, Gen, etc.)
  • :1 Cor 13 - Works with multi-word books too

Navigate Between Books:

  • :next - Load the next book in the Bible
  • :prev - Load the previous book in the Bible

Exit Command Mode:

  • Esc - Cancel and return to normal mode
  • Enter - Execute the command

Quitting

  • q or Q - Quit the pager
  • Ctrl+c - Force quit

Disclaimer

The Go program(s) included in the scripts directory are provided for personal and educational use only. This software is intended for lawful purposes such as learning, personal study, and authorized research.

Important Notice:

  • The author is not responsible for any misuse or abuse of this software
  • Users are solely responsible for ensuring their use complies with applicable laws and terms of service
  • This software is not intended for professional, commercial, or unauthorized use
  • By using this software, you agree to use it responsibly and legally

License Information

  • All software in this repository is licensed under the GNU General Public License v3.0 or later (GPLv3+)
  • The Catholic Public Domain Version (CPDV) of the Bible remains licensed under its original Creative Commons license
  • The output/results obtained from the Go program(s) in the scripts directory are considered fair use for personal and educational purposes
  • Important: Any content scraped from external sources remains subject to the original copyright holder's (USCCB/CCD) restrictions and terms of service. The GPL license applies only to the software code, not to the scraped content itself