@helloao/cli 0.0.1 → 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +37 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
## Hello AO CLI
|
|
2
|
+
|
|
3
|
+
A Command Line Interface (CLI) that makes it easy to generate and manage your own [Free Use Bible API](https://bible.helloao.org/).
|
|
4
|
+
|
|
5
|
+
Additionally, it includes many functions and utilities that can make working with commonly formatted Bible data much easier.
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
- Supports [USFM](https://ubsicap.github.io/usfm/), [USX](https://ubsicap.github.io/usx/), and Codex (A JSON format).
|
|
10
|
+
- Download over 1000 Bible translations from [fetch.bible](https://fetch.bible/).
|
|
11
|
+
- Import Bible translations into a SQLite database.
|
|
12
|
+
- Upload to S3, a zip file, or a local directory.
|
|
13
|
+
|
|
14
|
+
### Usage
|
|
15
|
+
|
|
16
|
+
```
|
|
17
|
+
Usage: helloao [options] [command]
|
|
18
|
+
|
|
19
|
+
A CLI for managing a Free Use Bible API.
|
|
20
|
+
|
|
21
|
+
Options:
|
|
22
|
+
-V, --version output the version number
|
|
23
|
+
-h, --help display help for command
|
|
24
|
+
|
|
25
|
+
Commands:
|
|
26
|
+
init [options] [path] Initialize a new Bible API DB.
|
|
27
|
+
import-translation [options] <dir> [dirs...] Imports a translation from the given directory into the database.
|
|
28
|
+
import-translations [options] <dir> Imports all translations from the given directory into the database.
|
|
29
|
+
generate-translation-files [options] <input> <dir> Generates API files from the given input translation.
|
|
30
|
+
generate-translations-files [options] <input> <dir> Generates API files from the given input translations.
|
|
31
|
+
upload-api-files [options] <dest> Uploads API files to the specified destination. For S3, use the format s3://bucket-name/path/to/folder.
|
|
32
|
+
fetch-translations [options] <dir> [translations...] Fetches the specified translations from fetch.bible and places them in the given directory.
|
|
33
|
+
fetch-audio [options] <dir> [translations...] Fetches the specified audio translations and places them in the given directory.
|
|
34
|
+
Translations should be in the format "translationId/audioId". e.g. "BSB/gilbert"
|
|
35
|
+
fetch-bible-metadata <dir> Fetches the Theographic bible metadata and places it in the given directory.
|
|
36
|
+
help [command] display help for command
|
|
37
|
+
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@helloao/cli",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.3",
|
|
4
4
|
"description": "A CLI and related tools for managing HelloAO's Free Bible API",
|
|
5
5
|
"module": "index.js",
|
|
6
6
|
"types": "index.d.ts",
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
"author": "Kallyn Gowdy <kal@helloao.org>",
|
|
11
11
|
"license": "MIT",
|
|
12
12
|
"dependencies": {
|
|
13
|
-
"@helloao/tools": "^
|
|
13
|
+
"@helloao/tools": "^0.0.3",
|
|
14
14
|
"commander": "12.1.0",
|
|
15
15
|
"@gracious.tech/fetch-client": "^0.7.0",
|
|
16
16
|
"prisma": "^5.12.1",
|