UniqueBibleApp is able to run in various modes:

• Webtop mode - Run UBA using docker

• GUI mode - A desktop application using the Qt library. Runs on Windows / macOS / Linux / Chrome OS platforms.

  python uba.py

  python uba.py gui

• CLI mode - A command line mode where all input and output is text based. Running CLI mode requires installing Qt library.

  python uba.py cli

• Terminal mode - A command line mode, running locally, where all input and output is text based, without installing Qt library. Most features available in GUI mode are available in Terminal mode. Moreover, Terminal mode offers some additional utilities.

  python uba.py terminal

• HTTP/Web mode - UBA acts as a web server and can be accessed by browsers. Runs on Windows / macOS / Linux / Chrome OS / Android / iOS platforms.

  python uba.py http-server

• SSH mode - UBA acts as a ssh server and can be accessed by ssh clients.

  python uba.py ssh-server

• Telnet mode - UBA acts as a telnet server and can be accessed by telnet clients.

  python uba.py telnet-server

• API mode - UBA acts as a API server. This allows access to UBA from Postman.

  python uba.py api-server

• Macro mode - Run a macro command.

  python uba.py execute-macro macro.ubam

Differences between Terminal / CLI / Telnet modes

Terminal, CLI, Telnet modes are text-based modes running via a console.

Terminal mode is the simplest one. It does not require users to install Qt graphical library, like PySide6, PySide2, or PyQt5. It runs locally without setting up a server. Users do not need a client to access UBA.

CLI is also running locally. CLI mode differs from Terminal mode in a way that it requires users to install a Qt graphical library. Running CLI mode allows users to switch to GUI mode, by running ".gui" command.

Telnet mode runs a telnet server on a device. Users need to use a telnet client to access UBA content, either locally or remotely via available networks.

Help to Choose

Some comments are given below to help you to choose a mode that suits your needs.

We recommend the following four modes, as they offer most UBA features to users:

gui mode - the most visual

http-server - the most accessible via internet

terminal mode - the quickest and the most comprehensive in case you are comfortable with command prompt

webtop - the most consistent UI across different platforms but requires docker to be installed