https://github.com/maxwelljens/bibel

Bible command line interface utility
https://github.com/maxwelljens/bibel

bible christian christianity cli command-line console linux productivity rust rust-lang terminal text

Last synced: 21 days ago
JSON representation

Bible command line interface utility

• Host: GitHub
• URL: https://github.com/maxwelljens/bibel
• Owner: maxwelljens
• License: eupl-1.2
• Created: 2021-09-25T17:47:26.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-12-15T12:51:34.000Z (over 1 year ago)
• Last Synced: 2024-06-21T18:53:38.522Z (10 months ago)
• Topics: bible, christian, christianity, cli, command-line, console, linux, productivity, rust, rust-lang, terminal, text
• Language: Rust
• Homepage: https://maxwelljensen.no/git/maxwelljensen/bibel
• Size: 4.95 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
![bibel](/logo.gif "bibel")

![GitHub](https://img.shields.io/github/license/maxwelljens/bibel?label=Licence) ![GitHub last commit](https://img.shields.io/github/last-commit/maxwelljens/bibel?label=Last%20Commit)

![preview](./preview.svg)

## What is bibel?

`bibel` (*bee•bell*) is a command line interface (CLI) utility for the Bible. Its primary use is for quick reference

from the command line and piping into other programs, as reading the whole Bible by itself in the command line is not

very comfortable.

## How do I use bibel?

    bibel [OPTIONS]... [ARGS]...

    ARGS:

               Book from the Bible

            Chapter in 

              Verse in 

If no arguments are specified, the entire Bible is printed. Specify BOOK to print a book from the Bible; specify BOOK

and CHAPTER to print a chapter from the Bible; specify BOOK, CHAPTER, and VERSE to print a verse or range of verses

from the Bible.

Example usage:

    $ bibel | grep "inherit the earth"

    Matthew. Chapter 5. [4] Blessed are the gentle, for they shall inherit the earth.

    $ bibel "1 mac" 1 1:6

    1 Maccabees. Chapter 1. [1] After Alexander the Macedonian, the son of Philip, who [...]

    $ bibel gen

    [Prints the entirety of Genesis]

## How does bibel work?

`bibel` uses simple substring matching to find books and chapters. This works completely adequately for most of

everything, although `bibel john X Y` will match both *Book of John* and letters from Saint John (*1 John*, *2 John*,

and *3 John*) as a consequence.

Names of books used are their standard short names, e.g. *1 Maccabees* instead of *The First Book of Maccabees*.

## How do I build bibel?

`bibel` is written in Rust. External dependencies are [bitflags](https://github.com/bitflags/bitflags),

[clap](https://github.com/clap-rs/clap), [colored](https://github.com/mackwic/colored),

[rayon](https://github.com/rayon-rs/rayon), and [rust-embed](https://github.com/pyros2097/rust-embed). The files in

`/web_bible` are embedded during compilation of `main.rs`, and are accessed thusly and portably at runtime.  The format

of text that is expected during embedding is as follows:

- **First line**: Book title

- **Second line**: Chapter

- **Every line after**: Verse

- Each text file is a chapter

## Licence

This project is licensed under [European Union Public Licence

1.2](https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12). The Bible used is the World English Bible, which

is in the public domain. World English Bible is a trademark of [eBible.org](https://www.ebible.org/).