🚀Getting Started

A quick guide on starting up Horus.

Prerequisites

In order to use Horus, you will need:

  • Python 3.11

Installation and Usage Instructions

To get started with this project, you will need Python installed on your device. Once it is installed, follow these steps:

  1. Clone this repository.

  2. cd to the 'horus' directory. (Make sure it isn't the outermost folder)

  3. Install dependencies using the following command: pip install -r requirements.txt

  4. In the 'horus' directory, run python3 horus.py on Linux/MacOS, or py horus.py on Windows

Note: protonvpn-cli is a requirement for the 'pvpn' command

API Configuration

To configure the APIs necessary for usage of certain commands, you can either manually enter them, or use the 'apicon' command

To manually configure API keys, navigate to /src/modules/var/pipes/api_config.json. Enter your API keys in their corresponding entries.

⚠ī¸ Warning: If you are contributing to this repository or are testing it through a public fork, make sure to remove your API keys from the JSON file before pushing changes.

PreviousIntroductionNextUsage

Last updated