KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agent #developer-tools #codex #typescript #cli #deepseek-harness #claude-code #ai-agents #mcp #rust

PentestGPT

★ 10 Open GitHub ↗

Penetration Testing via Nmap and Nikto, with a touch of AI.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# PentestGPT 🔒

PentestGPT is an open-source, AI-driven ethical hacking assistant designed to automate vulnerability scans, process raw scan data, and generate natural language security reports.

[![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://pentestgpt.streamlit.app)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)

## 🌟 Features

- **Automated Vulnerability Scanning**: Integrates with Nmap and Nikto
- **AI-Powered Analysis**: Generate detailed reports using advanced AI
- **Interactive Q&A**: Ask questions about scan results
- **Modern UI**: User-friendly Streamlit interface
- **Comprehensive Reporting**: Detailed vulnerability assessments and remediation suggestions

## 🚀 Quick Start

### Prerequisites

- Python 3.8+
- Nmap installed on your system
- Nikto installed on your system
- OpenRouter API key (free tier available)

### Installation

1. Clone the repository:
```bash
git clone https://github.com/yourusername/PentestGPT.git
cd PentestGPT
```

2. Create a virtual environment:
```bash
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
```

3. Install dependencies:
```bash
pip install -r requirements.txt
```

4. Set up environment variables:
```bash
cp .env.example .env
```
Edit `.env` and add your OpenRouter API key.

### Running Locally

1. Start the FastAPI backend:
```bash
uvicorn app.main:app --reload
```

2. In a new terminal, start the Streamlit frontend:
```bash
streamlit run frontend/app.py
```

3. Open your browser and navigate to `http://localhost:8501`

## 🔧 Configuration

### Environment Variables

- `OPENROUTER_API_KEY`: Your OpenRouter API key
- `LOG_LEVEL`: Logging level (default: INFO)
- `LOG_FILE`: Log file path (default: logs/pentest_gpt.log)
- `HOST`: Server host (default: 0.0.0.0)
- `PORT`: Server port (default: 8000)

### Scan Types

1. **Quick Scan**: Basic port scan and service detection
2. **Full Scan**: Comprehensive vulnerability assessment
3. **Custom Scan**: Configure your own scan parameters

## 📊 Features in Detail

### Vulnerability Scanning
- Network reconnaissance using Nmap
- Web vulnerability scanning with Nikto
- Custom scan configurations
- Real-time progress tracking

### AI-Powered Analysis
- Natural language report generation
- Risk assessment and prioritization
- Remediation suggestions
- Interactive Q&A about findings

### Modern Dashboard
- Real-time metrics
- Interactive results display
- Chat interface for queries
- Dark mode UI

## 🚀 Deployment

### Streamlit Cloud (Recommended)

1. Fork this repository
2. Sign up for [Streamlit Cloud](https://streamlit.io/cloud)
3. Create a new app pointing to your fork
4. Add your environment variables in Streamlit Cloud:
   - `OPENROUTER_API_KEY`
   - Other optional configurations

### Local Deployment

Follow the installation instructions above for local deployment.

## 🤝 Contributing

We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details.

1. Fork the repository
2. Create a feature branch
3. Commit your changes
4. Push to the branch
5. Open a Pull Request

## 📝 Version Control

We use semantic versioning (MAJOR.MINOR.PATCH):
- MAJOR: Incompatible API changes
- MINOR: New functionality (backwards-compatible)
- PATCH: Bug fixes (backwards-compatible)

### Branch Strategy
- `main`: Production-ready code
- `develop`: Development branch
- `feature/*`: New features
- `bugfix/*`: Bug fixes
- `release/*`: Release preparation

## ⚠️ Disclaimer

This tool is for educational and ethical testing purposes only. Always ensure you have explicit permission to test any systems or networks.

## 📄 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## 🙏 Acknowledgments

- [OpenRouter](https://openrouter.ai/) for providing AI capabilities
- [Streamlit](https://streamlit.io/) for the amazing UI framework
- [FastAPI](https://fastapi.tiangolo.com/) for the backend framework
- [Nmap](https://nmap.org/) and [Nikto](https://github.com/sullo/nikto) for security scanning

## Project Structure

```
PentestGPT/
├── app/                    # Backend FastAPI application
│   ├── main.py            # Main FastAPI application
│   ├── routers/           # API route handlers
│   ├── core/              # Core business logic
│   └── utils/             # Utility functions
├── frontend/              # Streamlit frontend
│   └── app.py            # Streamlit application
├── models/               # AI model integration
├── scanners/            # Scanner integrations (Nmap, Nikto)
├── tests/               # Test files
├── .env                 # Environment variables
├── requirements.txt     # Python dependencies
└── README.md           # Project documentation
```

PentestGPT

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README