Installation Guide¶

This guide covers all installation methods for SQLMap AI, including system requirements, dependencies, and troubleshooting.

System Requirements¶

Minimum Requirements¶

• Python: 3.8 or higher
• RAM: 2GB (4GB recommended for Ollama)
• Storage: 500MB free space
• Network: Internet connection for cloud AI providers

Recommended Requirements¶

• Python: 3.11 or higher
• RAM: 8GB (for optimal performance with Ollama)
• Storage: 2GB free space
• OS: Linux, macOS, or Windows 10/11

Installation Methods¶

Method 1: PyPI Installation (Recommended)¶

The easiest way to install SQLMap AI is through PyPI:

pip install sqlmap-ai

Verify Installation¶

sqlmap-ai --version

Expected output:

SQLMap AI v2.0.1

Method 2: Source Installation¶

For development or to get the latest features:

# Clone the repository
git clone https://github.com/atiilla/sqlmap-ai.git
cd sqlmap-ai

# Install in development mode
pip install -e .

Method 3: Virtual Environment (Recommended)¶

It's recommended to use a virtual environment to avoid conflicts:

# Create virtual environment
python -m venv sqlmap-ai-env

# Activate virtual environment
# On Windows:
sqlmap-ai-env\Scripts\activate
# On macOS/Linux:
source sqlmap-ai-env/bin/activate

# Install SQLMap AI
pip install sqlmap-ai

Dependencies¶

SQLMap AI automatically installs these dependencies:

Core Dependencies¶

• python-dotenv: Environment variable management
• requests: HTTP library
• pyyaml: YAML configuration files
• rich: Beautiful terminal output
• jinja2: HTML report templates
• cryptography: Security features

AI Provider Dependencies¶

• groq: Groq AI API client
• openai: OpenAI API client
• anthropic: Anthropic API client

Optional Dependencies¶

Install additional features:

# Development dependencies
pip install sqlmap-ai[dev]

# Local LLM support
pip install sqlmap-ai[local-llm]

# Enhanced reporting
pip install sqlmap-ai[reporting]

# All optional dependencies
pip install sqlmap-ai[all]

Platform-Specific Installation¶

Windows¶

1. Install Python: Download from python.org
2. Install Git: Download from git-scm.com
3. Open Command Prompt or PowerShell:

   pip install sqlmap-ai
   

macOS¶

1. Install Homebrew (if not installed):

   /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
   

2. Install Python:

   brew install python
   

3. Install SQLMap AI:

   pip3 install sqlmap-ai
   

Linux (Ubuntu/Debian)¶

1. Update package list:

   sudo apt update
   

2. Install Python and pip:

   sudo apt install python3 python3-pip python3-venv
   

3. Install SQLMap AI:

   pip3 install sqlmap-ai
   

Linux (CentOS/RHEL/Fedora)¶

1. Install Python:

   # CentOS/RHEL
   sudo yum install python3 python3-pip
   
   # Fedora
   sudo dnf install python3 python3-pip
   

2. Install SQLMap AI:

   pip3 install sqlmap-ai
   

Post-Installation Setup¶

1. Run Installation Check¶

sqlmap-ai --install-check

This command will: - Verify Python version - Check for required dependencies - Install SQLMap if needed - Create configuration directories - Validate AI provider setup

2. Set Up AI Provider¶

Choose and configure an AI provider:

# Check available providers
sqlmap-ai --check-providers

# Run configuration wizard
sqlmap-ai --config-wizard

3. Create Configuration Files¶

The installation check creates these files:

~/.sqlmap-ai/
├── .env                    # Environment variables
├── config.yaml            # Main configuration
└── logs/                  # Log files

Verification¶

Test Basic Functionality¶

# Check version
sqlmap-ai --version

# Show help
sqlmap-ai --help

# Check AI providers
sqlmap-ai --check-providers

# Validate configuration
sqlmap-ai --validate-config

Test with Sample Target¶

# Run a basic test
sqlmap-ai -u "http://testphp.vulnweb.com/listproducts.php?cat=1"

Troubleshooting¶

Common Issues¶

Python Version Issues¶

Problem: "Python 3.8+ required" Solution: Upgrade Python to 3.8 or higher

# Check Python version
python --version

# Install Python 3.11 (recommended)
# Windows: Download from python.org
# macOS: brew install python@3.11
# Linux: sudo apt install python3.11

Permission Issues¶

Problem: "Permission denied" during installation Solution: Use virtual environment or user installation

# User installation (no admin required)
pip install --user sqlmap-ai

# Or use virtual environment
python -m venv sqlmap-ai-env
source sqlmap-ai-env/bin/activate  # Linux/macOS
sqlmap-ai-env\Scripts\activate     # Windows
pip install sqlmap-ai

Network Issues¶

Problem: "Could not find a version that satisfies the requirement" Solution: Check internet connection and pip configuration

# Upgrade pip
pip install --upgrade pip

# Use alternative index
pip install -i https://pypi.org/simple/ sqlmap-ai

SQLMap Not Found¶

Problem: "SQLMap not detected" Solution: Install SQLMap manually

# Install SQLMap
pip install sqlmap

# Or let SQLMap AI install it
sqlmap-ai --install-check

Getting Help¶

If you encounter issues:

1. Check the logs: ~/.sqlmap-ai/logs/
2. Run diagnostics: sqlmap-ai --install-check
3. Validate config: sqlmap-ai --validate-config
4. Report issues: GitHub Issues

Uninstallation¶

To remove SQLMap AI:

# Remove the package
pip uninstall sqlmap-ai

# Remove configuration files (optional)
rm -rf ~/.sqlmap-ai/

Next Steps¶

After successful installation:

1. Configure AI Providers: Set up your preferred AI provider
2. Quick Start: Run your first test
3. User Guide: Learn how to use SQLMap AI effectively

Support¶

• 📖 Documentation: This site contains comprehensive guides
• 🐛 Issues: Report bugs on GitHub Issues
• 💬 Discussions: Join the conversation on GitHub Discussions