hackingtool README

The project's README from github.com/Z4nzu/hackingtool. As one markdown file: README.md.

HackingTool

AI-guided, all-in-one toolkit for authorized security testing

219 curated tools across 21 categories — recon, OSINT, web, wireless, phishing, forensics, post-exploitation and more — with an AI layer that turns plain English into the right tool and the exact command.

Built for penetration testers · red teamers · blue-team/SOC and DFIR analysts · OSINT researchers · bug-bounty hunters · CTF players · security researchers and students — all working legally, on systems they own or are authorised to test.

Sponsored by
WebVetted Intelligence - OSINT & Recon Platform

Go beyond manual recon. WebVetted turns an email, phone or username into a complete identity investigation with deep OSINT enrichment, breach intel, AI analysis, and an interactive identity graph.

Start an Investigation →



Z4nzu/hackingtool | Trendshift Z4nzu/hackingtool | Trendshift daily Z4nzu/hackingtool | Trendshift weekly


License Python Stars Forks Issues Last Commit Sponsor


       


Install Now  How to Use  Tool Catalog  Sponsor


Contents


Why hackingtool

hackingtool interactive TUI: categories with live tool counts, type to search all tools, / opens the command palette
The interactive console on launch — browse categories, type to search every tool, and / opens the command palette.

Tool Categories

219 tools across 21 categories — the full list, with links and tags, is in docs/TOOLS.md.

# Category Tools # Category Tools
1 🛡 Anonymously Hiding Tools 5 12 🔁 Reverse engineering tools 10
2 🔍 Information gathering tools 26 13 ⚡ DDOS Attack Tools 7
3 📚 Wordlist Generator 8 14 🖥 Remote Administrator Tools (RAT) 4
4 📡 Wireless attack tools 17 15 🧪 XSS Attack Tools 6
5 💉 SQL Injection Tools 7 16 🖼 Steganography Tools 10
6 🎣 Phishing attack tools 13 17 🏢 Active Directory Tools 10
7 🌐 Web Attack tools 23 18 ☁ Cloud Security Tools 7
8 🔧 Post exploitation tools 15 19 📱 Mobile Security Tools 6
9 🕵 Forensic tools 12 20 ✨ Other tools 10
10 📦 Payload creation tools 6 21 🔑 Password / Hash Cracking 7
11 🧰 Exploit framework 6

44 further entries are archived (unmaintained or dead upstream) and hidden unless you set show_archived true via /config. The in-app header counts 22 categories / 219 tools because it also counts the built-in Update / Uninstall menu.


Installation

Requires Python 3.10+ on Linux or macOS (Kali, Parrot, Debian/Ubuntu, Arch, …). Windows is not supported — the app tells you so and exits. No curl | bash: every path below is a standard, verifiable install.

pipx installs hackingtool into its own isolated environment and puts the hackingtool command on your PATH, so you can launch it from any directory.

# 1 — get the code
git clone https://github.com/Z4nzu/hackingtool.git
cd hackingtool

# 2 — install it onto your PATH (isolated venv, no system Python touched)
pipx install .

# 3 — run it from anywhere
hackingtool

No pipx yet?

# macOS
brew install pipx && pipx ensurepath

# Debian / Ubuntu / Kali
sudo apt install pipx && pipx ensurepath

Open a new shell after pipx ensurepath so the PATH change takes effect. To update later: git pull && pipx install . --force. To remove it: pipx uninstall hackingtool.

Alternative: uv tool install . (same result, uses uv instead of pipx)
git clone https://github.com/Z4nzu/hackingtool.git
cd hackingtool
uv tool install .        # installs the `hackingtool` executable on your PATH
hackingtool
Alternative: plain venv + pip (no PATH changes)
git clone https://github.com/Z4nzu/hackingtool.git
cd hackingtool
python3 -m venv .venv && . .venv/bin/activate
pip install .            # or: pip install -e .   for an editable dev install
hackingtool

The command is only on your PATH while that venv is activated.

For development

uv creates the virtualenv and installs everything from pyproject.toml / uv.lock in one step:

git clone https://github.com/Z4nzu/hackingtool.git
cd hackingtool
uv sync
uv run hackingtool

No uv yet? pipx install uv (or see the uv install docs).

Contributing? make setup wires the pre-push hook and make check runs the full gate (lint + tests + catalog validation). See CONTRIBUTING.md.

Docker

Pull and run the published image:

docker run -it --rm hardikzinzu/hackingtool:latest

Or build it locally from a checkout:

git clone https://github.com/Z4nzu/hackingtool.git && cd hackingtool
docker build -t hackingtool .
docker run -it --rm hackingtool

Optional runtimes

Some individual tools need a language runtime to install/run; the core app doesn't.

Dependency Version Needed for
Go 1.21+ nuclei, ffuf, amass, httpx, katana, dalfox, gobuster, subfinder
Ruby any haiti, evil-winrm
tmux any background panes (/run … &, /panes, /attach)
Docker any Mythic, MobSF (optional)

Quick Commands

hackingtool opens an interactive terminal UI: browse the categories, type to search every tool across all of them, ↑↓ to move, Enter to open, ←/Esc to go back, and / for the command palette (/config, /update, /menu, /quit). When a newer release is out it shows an update available line on launch, and /update detects how you installed hackingtool and shows the exact upgrade command to run.

For a keyboard-driven REPL instead, hackingtool --classic takes three kinds of input:

You type It means Example
/… a command you run /search subdomain
@… a thing you name @nmap, @tag:osint
anything else plain English "what I want to do" crack a wifi handshake
typing @ in the hackingtool console completes tool names
@ completes tool names — @tag: completes tags, / completes commands.

Command reference

Command Aliases What it does
/run <tool> [args] [&] /open open a tool's menu; with a trailing & it runs in a background tmux pane instead (that's where args are used)
/search <keyword> search tools by name, description or tag
/tags list every tag with its tool count
/ai <goal> /recommend, /r recommend tools for a goal
/goal <objective> AI-plan an objective and run it step by step, with per-step confirmation
/find <need> /discover find tools for a need — your catalog first, then GitHub (suggest-only)
/panes /jobs list background panes
/attach attach to the background session (Ctrl-b d to return)
/kill <label|all> kill one background pane, or all of them
/config [key value] view/change settings; /config test checks the AI connection, /config github checks the GitHub token
/skill show the operator playbook
/update · /uninstall /remove update system packages or hackingtool · remove hackingtool and its tools
/clear /cls clear the screen
/back /b leave the current tool and go back
/help /?, /h quick reference card
/quit /q, /exit exit (also q, Ctrl-C, Ctrl-D)
@<tool> open a tool (case-insensitive, fuzzy fallback)
@tag:<tag> list and pick from the tools carrying that tag

Inside a category: 1–N pick a tool · 97 install everything not yet installed · 98 archived tools · 99 back. Inside a tool: 1 install · 2 run · c ask for the exact command for your goal · 98 project page · 99 back.

hackingtool /help quick reference card
/help — the same card, in the app.

The command set above is the --classic REPL. On a non-interactive terminal hackingtool falls back to the classic numbered menu, where / or s searches, t filters by tag, r or a recommends, ? helps and q quits.

New here? docs/HOW-TO-USE.md walks through each of these start to finish with numbered steps.


Features

Where these live today. /find, /goal, plain-English recommendations, /tags//search and background panes currently run in the --classic REPL (hackingtool --classic). The default TUI browses and type-searches the whole catalog and runs tools; wiring these AI/search features into it is Phase 2. The screenshots below showing a / command prompt are the --classic REPL.

🔎 /find — a tool for a need you don't have yet

Searches the 219 curated tools first, then the GitHub search API, and ranks the results explainably. Suggest-only — it never clones, installs or runs anything — and it makes zero model calls.

/find crack a wpa handshake

In your toolbox (vetted)
  • aircrack-ng (WiFi security suite)
  • Kismet (wireless detector / WIDS)
  • Reaver (WPS PIN attack)
  • WiGLE (wardriving map & API)
  • hashcat example hashes (WPA mode 22000)

Found on GitHub — NOT vetted by us

  wifiphisher/wifiphisher  14713★  GPL-3.0
    The Rogue Access Point Framework
    14713★ · trusted author (ships in our catalog) · active · matches: security, wifi
    git clone https://github.com/wifiphisher/wifiphisher
  …

Press a to keep a result: it is saved to ~/.hackingtool/found.yaml as a "Discovered tools" entry — title, tags, description, link, and no install or run command, so a discovered entry can never execute anything. It shows up in your menu and in /search next launch.

Out-of-scope asks (jamming, DoS, mass-targeting, malware) are refused before any network call, with an authorized alternative where one exists. Defensive/DFIR phrasing is never refused.

Works anonymously at 10 GitHub searches/minute; a no-scope, no-permission token raises that to 30 — see /config github.

🎯 /goal — plan an objective, run it one step at a time

/goal find live subdomains of example.com

hackingtool drafts a short plan of real commands (with the reason for each step and an install hint for tools you don't have), asks you to confirm you are authorized to test the target, then walks the steps: [y] run · [s] skip · [e] edit · [q] abort. Every step runs list-form — never through a shell — and each goal gets a timestamped workspace under ~/.hackingtool/goals/ holding plan.json, a UTC-stamped run.log, and the raw output of each step.

The model is called once, for planning; tool output is never fed back to it. With no model configured, /goal degrades to tool recommendations for the same objective.

🧠 Recommendations — say what you want in plain English

Bare text (or /ai) maps intent to tools. The model may only return tags from the fixed taxonomy, and the catalog resolves tags → tools, so a tool can never be invented; with no model reachable a stdlib keyword matcher answers instead.

hackingtool /ai — pick a common task or describe your own
/ai — pick one of the common tasks, or type the job in your own words.

/tags prints every tag in use with its live tool count; @tag:<name> opens the tools carrying it; /search <keyword> matches names, descriptions and tags.

hackingtool /tags — every tag with its tool count
/tags — 63 tags in use, with the number of tools behind each.

▶ Background panes (tmux)

Long scans shouldn't block your console. With tmux installed, /run <tool> … & opens a labeled window in one detached hackingtool session:

/run nmap -sV -oA scan 10.0.0.5 &
▶ started 'nmap' in background — /attach to view

/panes lists them, /attach watches one (Ctrl-b d to come back), /kill <label> or /kill all stops them, and the status line under the prompt shows ▶ N running. No tmux? It says so and opens the tool inline instead; disable it entirely with /config background_runner off.

⚙ Settings and the AI layer

/config opens a searchable settings screen — type to filter, ↑↓ move, Enter cycles a choice or edits a value (auto-saved), ←/Esc back; in --classic it's a full-screen editor with t to test the AI connection. /config <key> <value> sets one key directly. Settings live in ~/.hackingtool/config.json.

The AI layer is opt-in and bring-your-own-key: an OpenAI-compatible endpoint when ai_base_url + an API key are set, else a local Ollama, else nothing — every feature degrades to a deterministic offline behaviour instead of guessing. Your API key is written only to ~/.hackingtool/.env (mode 600), never to config.json, and never printed back. /config test reports the real failure if a probe fails.

📋 Headless engagements

The same catalog drives a non-interactive orchestrator that normalizes tool output into one findings.json:

hackingtool --engagement acme --targets example.com --pipeline recon
hackingtool --engagement acme --report          # deterministic Markdown report
hackingtool --engagement acme --ai-summary      # opt-in triage of the REAL findings
hackingtool --engagement acme --ai-report       # opt-in narrative draft (report.draft.md)

Out-of-scope targets are flagged and logged before anything runs, and the AI passes only ever summarize findings that exist.


Documentation

Document What's in it
How to use hackingtool numbered walkthroughs: first run, /find, /goal, /config, background panes, headless mode
Tool catalog every tool, by category, with links and tags
Operator playbook the charter and grounding rules the AI layer runs under (also /skill)
SECURITY.md disclosure policy, release verification, threat model
CONTRIBUTING.md catalog-first tool additions, the gate your PR must pass

Contributing

New tools, fixes, and docs are all welcome — for authorized security testing only.

The easy path: most tools are just one YAML entry in src/hackingtool/catalog/ — no Python needed. Tags come from a fixed taxonomy, so your tool is instantly discoverable and searchable.

I want to… Do this
💡 Suggest a tool Open a Tool Request issue
➕ Add a tool Add a catalog entry (or a class for custom install/run logic), then open a PR with the template
🐛 Report a bug Open a Bug report issue
🔒 Report a vulnerability Privately — do not open a public issue; see SECURITY.md

Before opening a PR, run make check (lint + tests + catalog validation) and use the title format [New Tool] Name — Category. The full guide — security rules and the one-entry catalog walkthrough — is in CONTRIBUTING.md.

📄 Contributing · Security · Code of Conduct


Support & Sponsor

hackingtool is free and open-source. If it saves you time on an engagement or helps you learn, please consider sponsoring — funding goes to tool curation, the AI layer, and keeping installs safe and current.

Sponsor on GitHub  Buy Me A Coffee

⭐ Starring the repo is free and helps others discover the project.

Social

Twitter GitHub

For authorized security testing only. Thanks to all original authors of the tools included in hackingtool.

Your favourite tool is not listed? Suggest it here

hackingtool (Z4nzu/hackingtool)

Searching Database…

What is this?hackingtool is an AI-guided, all-in-one console that bundles 215 curated security tools across 21 categories (recon, OSINT, web, wireless, phishing, forensics, post-exploitation and more) for authorized penetration testing, red/blue team, OSINT, bug-bounty and CTF work.
Is this a GUI app or a terminal tool?It's an interactive terminal console: you launch it and type slash-commands (/search, /run), @ to open a tool, or plain English to get AI recommendations; it falls back to a classic numbered menu on non-interactive terminals.
What do I need to run it besides Python?You need Python 3.10+ on Linux or macOS; individual tools in the catalog may additionally need Go, Ruby, tmux or Docker depending on which tool you run.
Does it work on Windows?No - the app detects Windows and exits with an explanation instead of running.
Where does my AI API key get stored?If you configure an OpenAI-compatible endpoint, your API key is saved only to a local .env file with restricted permissions and is never written to the settings file or printed back.
What does /find do?It searches your 215-tool catalog first, then the GitHub search API, and suggests real maintained projects with a stated ranking reason - it only suggests, never clones, installs or runs anything.
What is /goal for?You type an objective and it drafts a short plan of real commands with reasons, then walks through each step letting you run, skip, edit or abort, logging everything to a timestamped workspace.
Do I need an API key for the AI features?No - the AI layer is optional and bring-your-own-key: use an OpenAI-compatible endpoint, run a local Ollama model, or skip it and get deterministic offline tool recommendations instead.
Is this safe to use, legally?It's designed only for authorized testing: out-of-scope requests like DoS, mass-targeting or malware are refused before any network call, and /goal requires you to confirm authorization before running anything against a target.
Creator
Z4nzu
Size
6.5 MB
Stars
82K
Updated
CommitOct 31
Age
6y
Commits · 90 Days