Quick Installation for Users
If you simply want to install and start using Tirith, this option provides a fast installation process with minimal setup. Perfect for end users and non-developers who only need basic functionality.
Prerequisite
Steps to Install Tirith
Step 1: Install using the pip command
pip install tirith installs an unrelated project of the same name, and pip install py-tirith
finds nothing: that is the package name in setup.py and it is not published. Installing Tirith
means installing from git, as below.
Run the following command in your terminal to install Tirith directly from the GitHub repository, pinned to a released tag:
pip install "git+https://github.com/StackGuardian/tirith.git@1.2.1"
Pin the tag rather than tracking the default branch, so an install today and an install next month
give you the same tool. 1.2.1 is the newest tag;
git ls-remote --tags https://github.com/StackGuardian/tirith.git lists them all.
To use the interactive interface as well, install the optional extra, which needs Python 3.9 or newer:
pip install "py-tirith[tui] @ git+https://github.com/StackGuardian/tirith.git@1.2.1"
Step 2: Verify Installation
Once installed, verify that Tirith is working by checking its version. You should see 1.2.1,
which confirms both that the install succeeded and that you got the tag you asked for.
tirith --version
