Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Z4nzu/hackingtool/llms.txt

Use this file to discover all available pages before exploring further.

​
Main Execution Commands

HackingTool provides multiple ways to launch and interact with the tool.

​
Primary Command

After installation, launch HackingTool using: 
hackingtool
This is the standard entry point installed to /usr/bin/hackingtool.

​
Python Execution

Run directly from the source directory: 
python3 hackingtool.py
The tool requires Python 3 and runs within a virtual environment when installed via the installer.

​
Installation Commands

​
System Installation

Install HackingTool system-wide with root privileges: 
sudo python3 install.py
The installer performs the following:
  • Clones repository to /usr/share/hackingtool
  • Creates Python virtual environment
  • Installs all requirements
  • Sets up launcher script at /usr/bin/hackingtool
​
install.py options
interactive
During installation, you’ll be prompted to:Distribution Selection
  • 1 - Kali/Parrot (apt-based)
  • 2 - Arch Linux (pacman)
  • 0 - Exit installation

​
Manual Git Clone

git clone https://github.com/Z4nzu/hackingtool.git
cd hackingtool
sudo python3 install.py

​
Interactive Menu System

HackingTool uses a numbered menu system with no command-line flags. When you run hackingtool, the main menu displays: 
0  - Anonymously Hiding Tools
1  - Information gathering tools
2  - Wordlist Generator
3  - Wireless attack tools
4  - SQL Injection Tools
5  - Phishing attack tools
6  - Web Attack tools
7  - Post exploitation tools
8  - Forensic tools
9  - Payload creation tools
10 - Exploit framework
11 - Reverse engineering tools
12 - DDOS Attack Tools
13 - Remote Administrator Tools (RAT)
14 - XSS Attack Tools
15 - Steganograhy tools
16 - Other tools
99 - Update or Uninstall | Hackingtool
​
menu selection
integer
Enter the number corresponding to your desired tool category, then press Enter.Special Options:
  • 99 - Access update/uninstall menu
  • Press Ctrl+C to exit at any time

​
Tool Selection Process

  1. Select Category - Choose from 0-16 or 99
  2. View Tools - See available tools in that category
  3. Choose Tool - Select specific tool by number
  4. Tool Actions - Most tools offer:
    • Install - Clone and install the tool
    • Run - Execute the tool
    • 98 - Open project page (if available)
    • 99 - Return to previous menu

​
Exit Codes

​
0
success
Normal exit - User selected exit from menu or completed operation successfully
​
1
error
Error exit - Installation failure, missing dependencies, or runtime error
​
KeyboardInterrupt
user action
User pressed Ctrl+C - Graceful shutdown initiated

​
Path Configuration

On first run, HackingTool prompts for installation path: 
Set Path
[1] Custom path
[2] Default path (/home/hackingtool/)
The path is saved to ~/hackingtoolpath.txt and used for all tool installations.

​
Custom Path Example

Select: 1
Enter Path: /opt/security-tools/
All tools will be cloned to subdirectories under this path.

​
Update Commands

From the main menu (option 99):

​
Update System

sudo apt update && sudo apt full-upgrade -y
sudo apt-get install tor openssl curl python3-pip

​
Update HackingTool

Automatic update process:
  1. Removes old installation from /etc/hackingtool/ and /usr/share/doc/hackingtool/
  2. Clones latest version from GitHub
  3. Runs new installer

​
Uninstall Commands

From the main menu (option 99 > Uninstall): 
# Removes:
# - /usr/share/doc/hackingtool/
# - /etc/hackingtool/
# - /usr/bin/hackingtool launcher
Individual tools installed in your custom path directory are NOT removed during uninstallation.

​
Platform Requirements

​
Linux
required
Supported: Debian-based (Kali, Parrot, Ubuntu) and Arch LinuxThe tool is designed for Linux penetration testing distributions.
​
Windows
not supported
Windows is not officially supported. A guidance message directs users to install Linux or use WSL.
​
macOS
partial
May work but not officially tested or supported.

​
Common Command Patterns

​
Quick Start

# Install
sudo python3 install.py

# Run
hackingtool

# Select category 1 (Information Gathering)
# Select tool 0 (NMAP)
# Choose Install
# Wait for installation
# Choose Run

​
Batch Tool Usage

Many tools support command-line arguments after installation: 
# Example: Running sqlmap directly
cd sqlmap-dev
python3 sqlmap.py -u http://example.com --batch

# Example: Running nmap
sudo nmap -O -Pn 192.168.1.1

​
Environment Variables

HackingTool reads and respects:
​
$HOME
path
Used for ~/hackingtoolpath.txt configuration file
​
$GOPATH
path
default:"$HOME/go"
Required for Go-based tools (e.g., DalFox)
​
$PATH
path list
Launcher script is installed to /usr/bin/ which should be in PATH

​
Troubleshooting Commands

​
Check Installation

which hackingtool
# Should output: /usr/bin/hackingtool

ls -la /usr/share/hackingtool/
# Should show cloned repository

​
Verify Python Environment

source /usr/share/hackingtool/venv/bin/activate
python3 --version
pip list

​
Permission Issues

# Fix tool directory permissions
sudo chmod -R 755 /usr/share/hackingtool/

# Re-run installer with sudo
sudo python3 install.py

​
Command Output

HackingTool uses the Rich library for colorful terminal output:
  • Magenta/Purple - Headers and titles
  • Green - Success messages
  • Red - Error messages
  • Yellow - Warnings and prompts
  • Cyan - Information and descriptions
Output formatting requires a terminal that supports ANSI color codes.

Build docs developers (and LLMs) love

Get started for freeTalk to us