Skip to content

Command Line Interface

Eliran Wong edited this page Mar 12, 2021 · 10 revisions

Command Line Interface

You can run UBA and read bible study materials with terminal / console.

Minimum UBA version

22.55

Enable CLI feature

To enable cli feature, you need to pass either "cli" or "gui" as an argument to "uba.py", i.e.

uba.py cli

OR

uba.py gui

Difference between "uba.py cli" & "uba.py gui"

Both enables cli features on UBA startup.

Run "uba.py cli" to start UBA with command line interface.

Run "uba.py gui" to start UBA with graphical user interface.

Difference between "uba.py" & "uba.py gui"

Both starts UBA with graphical user interface, but only the latter has cli feature enabled.

Run "uba.py" to start UBA with graphical user interface WITHOUT enabling CLI feature. Unless you restart UBA, you CANNOT switch to command line interface during running UBA.

Run "uba.py" to start UBA with graphical user interface WITH CLI feature enabled. You CAN switch between graphical user interface and command line interface at any time.

Switch between gui & cli

With CLI feature enabled, you can switch between graphical user interface and command line interface at any time.

Switch from gui to cli

You can select "Command Line Interface" from right-click context menu to switch to cli. This option is ONLY available if you have cli feature enabled.

Switch from cli to gui

Enter on terminal:

.gui

Available commands

When you run UBA with cli,

Enter '.bible' to read bible content, '.study' to read study content, '.gui' to launch gui, '.quit' to quit, or UBA command:

.bible

.study

.gui

.quit

UBA command means standard commands recognised by UBA

e.g.

John 3

John 3:16-18

John 3:16; Rm 5:8

John 3:16-16

COMPARE:::John 3:16

COMPARE:::KJV_NET:::John 3

TEXT:::CUV

CROSSREFERENCE:::John 3:16

COMMENTARY:::John 3:16

Reference on available commands

https://github.com/eliranwong/UniqueBible/blob/master/TextCommandParser.py

In-app UBA command reference

From version 22.64, UBA offers in-app reference on UBA commands:

A window showing UBA commands is accessible through menu under "Information" or "About" section.

On cli [local or telnet], users can enter ".help" to view documentation on UBA commands.

Clone this wiki locally