Skip to content
Back to top
View this page

# Install Lihzahrd

Lihzahrd is distributed as a Python package on PyPI, and, as a backup, on Steffo’s code forge.

Note

Make sure you have Python 3.14 or later installed on your system before proceeding!

## Command-line tools installation

If you intend to only use the command-line tools Lihzahrd provides, you can use the following installation methods.

### Recommended: pipx

pipx is the software recommended by the Python Packaging Authority for installing standalone Python applications, like the Lihzahrd command-line tools are.

If you have pipx installed, you can install Lihzahrd by running:

Terminal

    $ pipx install "lihzahrd[cli]"

You can then run the Lihzahrd command-line tools with:

Terminal

    $ lihzahrd

To later upgrade Lihzahrd, you can run:

Terminal

    $ pipx upgrade lihzahrd

### Alternative: pip in a venv

pip is the software included with Python for adding packages to your Python installation.

Since many operating systems rely on the local Python installation for their internal tools, using it directly there is strongly discourages, as that might break your operating system.

However, it is possible to create a virtual Python installation with the built-in `venv` module, and install Lihzahrd in isolation there.

To do so, first create a venv somewhere on your system by running:

Terminal

    $ python -m venv "lihzahrd_venv"

Then, activate the venv following the instructions for the shell you are currently using:

Terminal (Bash)

    $ source lihzahrd_venv/bin/activate

Terminal (Fish)

    $ source lihzahrd_venv/bin/activate.fish

Terminal (Powershell)

    > lihzahrd_venv\Scripts\activate.ps1

And finally, install the Lihzahrd command-line tools by running:

Terminal

    (lihzahrd_venv)$ pip install "lihzahrd[cli]"

You can then run the Lihzahrd command-line tools with:

Terminal

    (lihzahrd_venv)$ lihzahrd

Note

The command-line tools will only be available while the venv is activated; you’ll need to repeat the activation process each time you want to use them.

To later upgrade Lihzahrd, you can run:

Terminal

    (lihzahrd_venv)$ pip install --upgrade "lihzahrd[cli]"

## Library installation

If you intend to develop a Python application based on Lihzahrd, you can add it as a dependency to your project’s pyproject.toml file.

`pyproject.toml`

    dependencies = [
        "lihzahrd>=4",
    ]

It is not tipically required by a standalone Python application, but if necessary, you can include the command-line tools by adding the `cli` extra as a dependency:

`pyproject.toml`

    dependencies = [
        "lihzahrd[cli]>=4",
    ]