https://github.com/strongs-de/bible-cli
https://github.com/strongs-de/bible-cli
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/strongs-de/bible-cli
- Owner: strongs-de
- Created: 2021-03-17T17:35:25.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-11-16T21:44:39.000Z (over 2 years ago)
- Last Synced: 2024-10-30T00:52:34.412Z (6 months ago)
- Language: Rust
- Size: 139 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
- awesome-bible-developer-resources - Bible CLI
README
# Bible CLI
The purpose of this tool is to be able to read, search, export bible data. Right
now there's only a parser for the Zefania XML format. Bible Translations
in the Zefania XML format can be downloaded from
[strongs-de/zefania-xml-bibles](https://github.com/strongs-de/zefania-xml-bibles)
or [SourceForge](https://sourceforge.net/projects/zefania-sharp/files/Bibles/).
```
USAGE:
bible-cli.exe [OPTIONS] [SUBCOMMAND]
OPTIONS:
-h, --help Print help information
-v, --verbose Sets the level of verbosity
-V, --version Print version information
SUBCOMMANDS:
export Exports the bible into static json files
help Print this message or the help of the given subcommand(s)
search searches in the bible
serve serves the bible REST api
```
## Export command
This command can be used to export a bible file into many json files. These files
can be used to display the new [strongs-v2](https://github.com/strongs-de/strongs-v2)
web ui.
```
USAGE:
bible-cli export [OPTIONS]
OPTIONS:
-h, --help Print help information
-o, --outdir Output directory
```
Examples:
```bash
# Export a single bible
bible-cli bibles/GER_LUTH1912.xml export
# Export all bible files in a folder
bible-cli "bibles/*.xml" export
```
## Search command
You can use `bible-cli` to search for a word or phrase in a bible translation, using the search command.
```
USAGE:
bible-cli search [OPTIONS] [--] [TERM]
ARGS:
search term
OPTIONS:
-h, --help Print help information
-t, --times [
Examples:
```bash
# Search for a word
bible-cli bibles/GER_LUTH1912.xml search Abraham
```
## Serve command
You can use `bible-cli` to provide a rudimentary REST Api for a chosen bible translation.
```
USAGE:
bible-cli.exe serve [OPTIONS]
OPTIONS:
-f, --folder [...] Path to the bible XML files
-h, --help Print help information
-p, --port [...] Port to host the API (default: 8000)
```
Examples:
```bash
bible-cli bibles/GER_ELB1905_STRONG.xml serve
```
The endpoints available are:
```bash
# Get info of the chosen bible translation
curl http://localhost:8000/{identifier}/info
{
"identifier": "ELB1905STR",
"name": "Elberfelder 1905"
}
# Return a bible chapter
curl http://localhost:8000/{identifier}/{book}/{chapter}
{
"chapter": 1,
"verses": [
{
"verse": 0,
"chunks": [
{
"text": "Darauf",
"strong": {
"number": 1899,
"grammar": null
}
}
]
}
]
}
# Search in the chosen bible
curl http://localhost:8000/{identifier}/{search_term}
[
"0_16_4",
"0_16_8",
"0_16_14",
"0_16_16",
"0_16_17",
"0_16_21"
]
# Hint: The result is a list of strings in the format "{book_nr}_{chapter_nr}_{verse_nr}"
```
# Run with docker
You can use `bible-cli` with docker:
```bash
docker run --rm -it -v `pwd`:/data mirhec/bible-cli "/data/bibles/*.xml" export
```