pentest-ai - AI-Powered Pentesting Assistant
pentest-ai is a Python utility that leverages AI to assist with penetration testing tasks. Created by AKM Korishee Apurbo, it interactively guides users in building and executing pentesting commands on Kali Linux, featuring a vibrant CLI powered by Groq.
Features
- AI-Driven Guidance: Interactively builds pentesting commands step-by-step using Groq’s AI.
- Tool Support: Works with tools like
nmap,sqlmap,hashid,hashcat, and more. - Interactive Execution: Executes commands in a new terminal window (e.g.,
xterm). - Colorful Interface: Uses
coloramaandpyfigletfor a fun, animated experience with emojis 🌟. - API Key Management: Set and store your Groq API key with a single command.
Installation
To install pentest-ai, use the following command:
pip install pentest-ai
Requirements
- Python 3.7+
- Dependencies:
groq,colorama,pyfiglet(installed automatically) - Groq API key (get one from Groq)
- Pentesting tools (e.g.,
nmap,sqlmap) installed on your system - Terminal emulator like
xterm
Usage
1. Set Your Groq API Key
Before using the tool, set your API key:
pentest-ai --api "your_groq_api_key"
This saves the key to ~/.pentest_ai_config.json.
2. Start the Pentesting Assistant
Run the tool to start the interactive assistant:
pentest-ai
It will display a colorful logo and prompt you for input:
[Animated "PenTest AI" logo]
AI Pentesting Chatbot 🎉 Powered by AKM Korishee Apurbo 🚀
Welcome to PenTest AI! 🎉 Type 'exit' to quit. 🚪
You 👤:
3. Interact with the Assistant
Type commands or questions (e.g., "scan a network", "identify a hash") to build and execute pentesting tasks.
Example Commands
-
Set the API key:
pentest-ai --api "gsk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
-
Start the tool:
pentest-ai
-
Scan a network (interactive):
pentest-ai You 👤: scan a network [Follow prompts to specify network]
-
Identify a hash (interactive):
pentest-ai You 👤: identify a hash [Follow prompts to provide hash]
Example Output
Scanning a Network
You 👤: scan a network
Korishee 🤖: COMMAND: nmap -sP <network>
Explanation 📝: This uses nmap to ping scan a network and find live hosts.
Korishee asks ❓: What network would you like to scan (e.g., 192.168.1.0/24)? 🌐
You 👤: 192.168.1.0/24
Korishee 🤖: COMMAND: nmap -sP 192.168.1.0/24
Command executed in a new terminal window! 🎉
Identifying a Hash
You 👤: identify a hash
Korishee 🤖: COMMAND: hashid <hash>
Explanation 📝: This uses hashid to identify the type of a hash.
Korishee asks ❓: Please provide the hash you want to identify! 🔍
You 👤: 5f4dcc3b5aa765d61d8327deb882cf99
Korishee 🤖: COMMAND: hashid 5f4dcc3b5aa765d61d8327deb882cf99
Command executed in a new terminal window! 🎉
Setting API Key
pentest-ai --api "gsk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
API key saved to ~/.pentest_ai_config.json! 🎉
Options
--api <key>: Set and save your Groq API key for the tool to use.
License
This project is open-source and available under the MIT License.
pentest-ai is designed to make pentesting fun and efficient. Whether you’re scanning networks or cracking hashes, Korishee is your AI sidekick! 🌟 Questions? Reach out at bandinvisible8@gmail.com.
Metadata
Release files for pentest-ai 0.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pentest_ai-0.1.2.tar.gz | 7.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pentest_ai-0.1.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 14.5 kB
Release files / pentest_ai-0.1.2.tar.gz
| Download URL | pentest_ai-0.1.2.tar.gz |
|---|---|
| Size | 7.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
11a5c1466b7b23395c7304da7dc39bb37a02baf55063f594e34bb12d0943d2a6
|
|
BLAKE2b-256 checksum How to use checksums |
887eff12395b572fb9a58abc5de935d3d298ddac5c2535676d0e634864b1ac58
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Release files / pentest_ai-0.1.2-py3-none-any.whl
| Download URL | pentest_ai-0.1.2-py3-none-any.whl |
|---|---|
| Size | 7.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5284be9a84747cf6c53c9e7f08b7f04e7e6a5597b4f5d28f4082a3187fc55440
|
|
BLAKE2b-256 checksum How to use checksums |
37cdcad64191f721fc9c329ab2bb32e56a1318cad644f855e7e9a5b1d85c3b03
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|