Pentest hud buddy

A sophisticated system designed to integrate artificial intelligence with penetration testing tools. The Modular Kali Agent combines a graphical user interface, terminal integration, AI-powered analysis, and workflow automation to assist security professionals.

Project Architecture

The system uses a client-server architecture with two main components:

1. modular_main (Backend): Provides API services, LLM integration, and core processing functionality
2. modular_agent (Frontend): Implements the agent UI and user interaction layer

graph TD
    A[modular_agent<br>Frontend] -->|API Calls| B[modular_main<br>Backend]
    B -->|Commands| A
    
    subgraph "modular_agent"
        A1[UI Components]
        A2[Utilities]
        A3[State Management]
    end
    
    subgraph "modular_main"
        B1[API Server]
        B2[LLM Interface]
        B3[Workflow Engine]
        B4[Tool Registry]
        B5[RAG Manager]
    end
    
    A1 --> A3
    A2 --> A3
    A3 --> A
    
    B1 --> B
    B2 --> B
    B3 --> B
    B4 --> B
    B5 --> B

Loading

For more detailed architecture diagrams, see the Architecture Documentation.

Key Features

• AI-Powered Analysis: Integration with Large Language Models for intelligent analysis
• Terminal Integration: Seamless interaction with command-line tools
• Screenshot Analysis: OCR processing of screen content
• Workflow Automation: Pre-defined and customizable security workflows
• Context Management: Intelligent tracking of analysis context
• Modular Design: Extensible architecture for adding new capabilities

Getting Started

Prerequisites

• Python 3.9+
• Required Python packages (see requirements.txt)
• Tkinter support for GUI
• API key for your preferred LLM provider
• Tesseract OCR (for image text extraction)

Installation

1. Clone this repository:

   git clone https://github.com/yourusername/modular-kali-agent.git
   cd modular-kali-agent
   

2. Install dependencies:

   pip install -r requirements.txt
   

3. Configure the application:

   • Copy config.json.example to config.json
   • Add your LLM API keys and customize settings

4. Start the backend server:

   python -m modular_main
   

5. Launch the agent interface:

   python -m modular_agent
   

Use "kali_agent.py" if you modular_agent does not work

python kali_agent.py

Usage

1. Use the main HUD to access various agent functions
2. Capture screenshots for analysis
3. Execute terminal commands with AI assistance
4. Run predefined workflows for common tasks
5. Analyze tool output with AI integration

Project Structure

• modular_main/: Backend components, API server, LLM integration
• modular_agent/: Frontend components, UI, and user interaction
• Docs/: Comprehensive documentation
• tests/: Test cases for various components

IMAGES

1.png: Full frontent(main image)

2.png: workflow module implementation

3.png: Auto command analyis inteface

4.png: MCP server client connection interface

5.png: MCP server ( server management)

6.png: backend initialization at ending of terminal output

7.png: backend initialization at startiing eg of terminal output

8.png: dashboard interface of backend system

9.png: configuration interface of backend system

Known Issues

See Current_Problems.md for a list of known issues and limitations.

Future Features

See Future_Features.md for planned enhancements and features.

Documentation

For comprehensive documentation, see the Docs directory, starting with README.md.

License

MIT License

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.