Skip to content

Chiagoziem4/AI-Sec-Assistant

Repository files navigation

AI-Sec-Assistant

An AI security assistant that uses your API key or a local llm to run network scans PROCEDURE BELOW Use this exact flow:

  1. Clone the repo:
git clone https://github.com/Chiagoziem4/AI-Sec-Assistant.git
cd AI-Sec-Assistant
  1. Create and activate a virtual environment:
python3 -m venv .venv
source .venv/bin/activate
  1. Install dependencies:
pip install --upgrade pip
pip install -r requirements.txt
  1. (Optional) Run tests:
python -m pytest tests/ -v
  1. Run with sample data in rule-only mode (no API needed):
python main.py --file sample_scan.txt --no-ai --json --markdown
  1. Run with AI mode:
python main.py --file sample_scan.txt --json --markdown

Then choose at prompt:

  • 1 for OpenAI
  • 2 for Ollama
  • 3 for rules-only
  1. If using OpenAI:
  • Put your key in .env as OPENAI_API_KEY=..., or
  • choose 1 and enter key when prompted.
  1. If using Ollama:
ollama serve
ollama pull llama3
python main.py --file sample_scan.txt --json --markdown

Then choose 2.

  1. Use real scan files:
sudo nmap -sV -oN live_scan.txt 192.168.1.0/24
python main.py --file live_scan.txt --format nmap --json --markdown
  1. Check generated reports:
  • They are saved in outputs/ as timestamped .json and .md files.

About

An AI security assistant that uses your API key or a local llm to run network scans

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages