CLI Reference
bt
Bible Translations CLI - A tool to fetch and export Bible translations.
Usage:
bt [OPTIONS] [COMMAND] [ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--version |
boolean | Show the version and exit. | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
Subcommands
- book: Fetch and export a specific book (e.g., 'John').
- books: Fetch and export all books.
- chapter: Fetch and export a specific chapter (e.g., 'John 3').
- selection: Fetch and export a selection (e.g., 'John 3:16' 'John 3:17').
- verse: Fetch and export a specific verse (e.g., 'John 3:16').
book
Fetch and export a specific book (e.g., 'John').
Usage:
bt book [OPTIONS] BOOK
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--output, -o |
path | Output file path. Default is generated with date. | Sentinel.UNSET |
--format, -f |
choice (json) |
Output format. | json |
--translation, -t |
choice (KJV | ASV | WEB | YLT | DARBY | DRA) |
Bible translation to use. | KJV |
--flat |
boolean | Export a flat list of verse records instead of the nested book/chapter/verse structure. | Sentinel.UNSET |
--verbose, -v |
boolean | Show verbose output. | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
books
Fetch and export all books.
Usage:
bt books [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--output, -o |
path | Output file path. Default is generated with date. | Sentinel.UNSET |
--format, -f |
choice (json) |
Output format. | json |
--translation, -t |
choice (KJV | ASV | WEB | YLT | DARBY | DRA) |
Bible translation to use. | KJV |
--flat |
boolean | Export a flat list of verse records instead of the nested book/chapter/verse structure. | Sentinel.UNSET |
--verbose, -v |
boolean | Show verbose output. | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
chapter
Fetch and export a specific chapter (e.g., 'John 3').
Usage:
bt chapter [OPTIONS] CHAPTER
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--output, -o |
path | Output file path. Default is generated with date. | Sentinel.UNSET |
--format, -f |
choice (json) |
Output format. | json |
--translation, -t |
choice (KJV | ASV | WEB | YLT | DARBY | DRA) |
Bible translation to use. | KJV |
--flat |
boolean | Export a flat list of verse records instead of the nested book/chapter/verse structure. | Sentinel.UNSET |
--verbose, -v |
boolean | Show verbose output. | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
selection
Fetch and export a selection (e.g., 'John 3:16' 'John 3:17').
Usage:
bt selection [OPTIONS] START_REF END_REF
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--output, -o |
path | Output file path. Default is generated with date. | Sentinel.UNSET |
--format, -f |
choice (json) |
Output format. | json |
--translation, -t |
choice (KJV | ASV | WEB | YLT | DARBY | DRA) |
Bible translation to use. | KJV |
--flat |
boolean | Export a flat list of verse records instead of the nested book/chapter/verse structure. | Sentinel.UNSET |
--verbose, -v |
boolean | Show verbose output. | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | Sentinel.UNSET |
verse
Fetch and export a specific verse (e.g., 'John 3:16').
Usage:
bt verse [OPTIONS] VERSE
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--output, -o |
path | Output file path. Default is generated with date. | Sentinel.UNSET |
--format, -f |
choice (json) |
Output format. | json |
--translation, -t |
choice (KJV | ASV | WEB | YLT | DARBY | DRA) |
Bible translation to use. | KJV |
--flat |
boolean | Export a flat list of verse records instead of the nested book/chapter/verse structure. | Sentinel.UNSET |
--verbose, -v |
boolean | Show verbose output. | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | Sentinel.UNSET |