Manual Installation (Using a Python Virtual Environment)

If you prefer a manual setup, especially if you want to modify Tirith’s codebase directly, follow these steps to install Tirith in a virtual Python environment.

Prerequisite

• Make sure your machine has Python and pip installed.
• Install Git on your machine.

Steps to Install Tirith

Step 1: Clone the Repository

Clone the Tirith repository from GitHub to get the latest code:

git clone https://github.com/StackGuardian/tirith.git
cd tirith

Step 2: Set Up a Python Virtual Environment

Setting up a virtual environment isolates Tirith’s dependencies, preventing potential conflicts with other projects on your machine.

Create a Virtual Environment:

virtualenv .venv

Activate the Virtual Environment:

source .venv/bin/activate

This command activates the virtual environment, ensuring all packages you install are contained within this environment.

Step 3: Install Tirith

With the virtual environment activated, install Tirith:

pip install -e .

The -e flag installs Tirith in editable mode, allowing you to make modifications to the codebase without needing to reinstall the package.

Step 4: Verify Installation

To confirm Tirith is installed and running properly, check its version:

tirith --version

You should see a version number output, verifying that Tirith is set up correctly.