Skip to content

Install bible-tui

bible-tui runs on macOS and Linux with Python 3.9+. It has no dependencies, so any of these takes a few seconds. The latest release is v0.10.0.

  1. Homebrew

    The easiest way on macOS and Linux. Homebrew brings its own Python.

    brew install codysechelski/tap/bible-tui
  2. pipx

    Uses your Python 3.9 or newer and keeps bible-tui in its own environment.

    pipx install bible-tui
  3. pip

    Works too, but pipx keeps bible-tui and its environment separate from everything else.

    pip install bible-tui
  4. From source

    No install step: there are no dependencies, so the clone runs as is.

    git clone https://github.com/codysechelski/bible-tui.gitcd bible-tui./bible-tui

Run it

Type bible-tui. Press t to switch versions, ? for every command, and q to quit.

CommandDoes
bible-tuiOpen the default version
bible-tui asvOpen a version by abbreviation
bible-tui ~/my.sqliteOpen a database file directly
bible-tui --bibles-dir ~/BiblesSearch an extra folder (repeatable)
bible-tui --list-versionsList every version it finds
bible-tui --pathsShow the config, state, and Bible folders in use

New here? Start with the feature tour or the key bindings.

Updating

bible-tui checks for a new release once a day and says so in the footer. Run :update inside the app to install it and reopen at the same verse, or update with the tool you installed it with:

Homebrew
brew upgrade bible-tui
pipx
pipx upgrade bible-tui
pip
pip install --upgrade bible-tui
From source
git pull

To turn the check off, set "check_for_updates": false in config.json.

Adding versions

The public-domain KJV and ASV come with it. Every other version is one SQLite file: copy it into ~/.config/bible-tui/bibles/ and it shows up in the version picker. To make one from a Bible you have the rights to, see Adding Bibles.

Uninstalling

Homebrew
brew uninstall bible-tui
pipx
pipx uninstall bible-tui
pip
pip uninstall bible-tui
From source
rm -rf bible-tui

Your settings, marks, and highlights stay in the app home (~/.config/bible-tui by default; bible-tui --paths shows it). Delete that folder too to remove everything.

Contributing

bible-tui is open source on GitHub (opens in a new tab). Bug reports and ideas are welcome in the issues (opens in a new tab); see CONTRIBUTING.md (opens in a new tab) and the roadmap (opens in a new tab).