- 🚀 About Horus
- ⚡ Installation and Usage Instructions
- ⚙️ API Configuration
- 🔮 Intended Features
- 🤝 Current Maintainers
- 🛠️ Contributing
- 📧 Contact Me
- 🤝 Acknowledgements
Horus is an all-in-one encompassing tool for investigations assistance, from API leveraging to compiling data too. Its your pre-ops buddy!
To get started with this project, you will need Python installed on your device. Once it is installed, follow these steps:
- Clone this repository.
cd
to the 'horus' directory. (Make sure it isn't the outermost folder)- Install dependencies using the following command:
pip install -r requirements.txt
- In the 'horus' directory, run
python3 horus.py
on Linux/MacOS, orpy horus.py
on Windows
Note: protonvpn-cli is a requirement for the 'pvpn' command Note: openvpn CLI is a requirement for the 'ovpn' command
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.
🟢 = Fully implemented or more than 80% done
🟡 = Partially implemented / In development
🔴 = To be implemented
On Shodan: Shodan is a paid API, so in order for your API to work you need to subscribe to them. A lot of its feature's location-related functionality is available in 'geolock', but more detailed features require that API.
- 6abd (Me) | Project Lead and Developer
- If you notice a bug or want to request a feature, make an issue with the appropriate tag
- If you would like to fix a bug or add a feature yourself, make a PR and I'll take a look
- If you would like to become a long-term maintainer/contributor, contact me
- For any other inquiries, you may also contact me
- Email: [email protected]
- Discord: maestro.hq or through the community server
- Fox | Was Previously Project Manager
- Tornado | Was Previously QA
- Mart | Was Previously Sr Dev
- Mu | Was Previously Jr Dev
Some code used can be attributed to Fox and Askerdyne Ltd., specifically the 'Loki' encryption toolset.
Some .github
files were made by Jesse Squires