### Шаг 2: Настройка окружения Python

**Linux/macOS:**```bash
python3 -m venv venv
source venv/bin/activate
pip install -e .

### Шаг 3: Настройка AI-провайдера

Guardian поддерживает несколько AI-провайдеров. Настройте предпочитаемого провайдера в `config/guardian.yaml`:```yaml
# config/guardian.yaml
ai:
  # Choose your provider: openai, claude, gemini, openrouter, or requesty
  provider: openai
  
  # OpenAI Configuration (recommended)
  openai:
    model: gpt-4o
    api_key: sk-your-api-key-here  # Or set OPENAI_API_KEY env var
  
  # Claude Configuration
  claude:
    model: claude-3-5-sonnet-20241022
    api_key: null  # Or set ANTHROPIC_API_KEY env var
  
  # Gemini Configuration
  gemini:
    model: gemini-2.5-pro
    api_key: null  # Or set GOOGLE_API_KEY env var
  
  # OpenRouter Configuration
  openrouter:
    model: anthropic/claude-3.5-sonnet
    api_key: null  # Or set OPENROUTER_API_KEY env var

  # Requesty Configuration (OpenAI-compatible gateway)
  requesty:
    model: openai/gpt-4o-mini
    api_key: null  # Or set REQUESTY_API_KEY env var

### Шаг 4: Инициализация конфигурации```bash
# Verify installation
python -m cli.main --help

# Check AI provider status
python -m cli.main models

### Примеры сценариев использования

#### 1. Быстрое тестирование на проникновение веб-приложения```bash
# Fast security check with evidence capture
python -m cli.main workflow run --name web_pentest --target https://dvwa.csalab.app

#### 3. Настраиваемый рабочий процесс с параметрами```bash
# Run with workflow-specific parameters
# Parameters in workflow YAML override config defaults
python -m cli.main workflow run --name web_pentest --target example.com

#### 5. Смена провайдеров ИИ```bash
# Use OpenAI GPT-4
python -m cli.main workflow run --name web_pentest --target example.com --provider openai

# Use Claude
python -m cli.main workflow run --name web_pentest --target example.com --provider claude

# Use Gemini
python -m cli.main workflow run --name web_pentest --target example.com --provider gemini

# Local Ollama (no cloud)
OLLAMA_HOST=http://localhost:11434 python -m cli.main workflow run --name recon --target scanme.nmap.org --provider ollama

# Any OpenAI-compatible endpoint (vLLM, LM Studio, Together, Groq)
python -m cli.main workflow run --name web_pentest --target example.com --provider openai_compatible

Включите привязку аналитика в `config/guardian.yaml`:```yaml
rag:
  enabled: true
  top_k: 5

Три роли (красный защитник, синий защитник, судья) обсуждают только неоднозначные выводы — уверенные вердикты пропускают обсуждение, чтобы ограничить затраты токенов.

#### 8. Визуальная триаж (vision-LLM)```bash
# Captures full-page screenshots and feeds them to a vision-capable provider
python -m cli.main workflow run --name web_visual_pentest --target https://example.com --provider openai

#### 10. Телеметрия + Learned Ranker (оффлайн)```bash
# Anonymise sessions into JSONL (no raw targets, no commands, no secrets)
python -m cli.main telemetry export ./reports --out telemetry.jsonl

# Train the offline tool ranker
python -m cli.main telemetry train telemetry.jsonl

# Inspect what the ranker learned
python -m cli.main telemetry status

> **Пользователям Windows**: используйте `python -m cli.main` вместо `guardian`

---

## 🔧 Конфигурация

### Полный справочник по конфигурации

Отредактируйте `config/guardian.yaml`, чтобы настроить поведение Guardian:```yaml
# AI Configuration
ai:
  provider: openai  # openai, claude, gemini, openrouter, requesty
  
  openai:
    model: gpt-4o
    api_key: sk-your-key  # Or use OPENAI_API_KEY env var
  
  claude:
    model: claude-3-5-sonnet-20241022
    api_key: null
  
  gemini:
    model: gemini-2.5-pro
    api_key: null
  
  temperature: 0.2
  max_tokens: 8000

# Penetration Testing Settings
pentest:
  safe_mode: true              # Prevent destructive actions
  require_confirmation: true   # Confirm before each step
  max_parallel_tools: 3        # Concurrent tool execution
  max_depth: 3                 # Maximum scan depth
  tool_timeout: 300            # Tool timeout in seconds

# Output Configuration
output:
  format: markdown             # markdown, html, json
  save_path: ./reports
  include_reasoning: true
  verbosity: normal            # quiet, normal, verbose, debug

# Scope Validation
scope:
  blacklist:                   # Never scan these
    - 127.0.0.0/8
    - 10.0.0.0/8
    - 172.16.0.0/12
    - 192.168.0.0/16
  require_scope_file: false
  max_targets: 100

# Tool Configuration (defaults)
tools:
  httpx:
    threads: 50
    timeout: 10
    tech_detect: true
  
  nuclei:
    severity: ["critical", "high", "medium"]
    templates_path: ~/nuclei-templates
  
  nmap:
    default_args: "-sV -sC"
    timing: T4

**Приоритет параметров:**
- Параметры рабочего процесса **переопределяют** параметры конфигурации
- Параметры конфигурации **переопределяют** значения по умолчанию инструмента
- Автономные, многократно используемые рабочие процессы

---

## 📖 Документация

### Руководства пользователя
- **[Руководство по быстрому старту](https://github.com/zakirkun/guardian-cli/blob/HEAD/QUICKSTART.md)** — Начало работы за 5 минут
- **[Справочник команд](https://github.com/zakirkun/guardian-cli/blob/HEAD/docs/)** — Подробная документация по всем командам
- **[Руководство по настройке](https://github.com/zakirkun/guardian-cli/blob/HEAD/config/guardian.yaml)** — Полный справочник по конфигурации
- **[Руководство по рабочим процессам](https://github.com/zakirkun/guardian-cli/blob/HEAD/docs/WORKFLOW_GUIDE.md)** — Создание пользовательских рабочих процессов
- **[Руководство по оценке](https://github.com/zakirkun/guardian-cli/blob/HEAD/docs/EVAL_GUIDE.md)** — Запуск и расширение средства оценки
- **[Руководство по плагинам](https://github.com/zakirkun/guardian-cli/blob/HEAD/docs/PLUGIN_GUIDE.md)** — Поставка сторонних провайдеров и инструментов
- **[Список изменений](https://github.com/zakirkun/guardian-cli/blob/HEAD/CHANGELOG.md)** — История версий и примечания по миграции

### Руководства для разработчиков
- **[Создание пользовательских инструментов](https://github.com/zakirkun/guardian-cli/blob/HEAD/docs/TOOLS_DEVELOPMENT_GUIDE.md)** — Разработка собственных интеграций инструментов
- **[Разработка рабочих процессов](https://github.com/zakirkun/guardian-cli/blob/HEAD/docs/WORKFLOW_GUIDE.md)** — Создание пользовательских тестовых рабочих процессов
- **[Доступные инструменты](https://github.com/zakirkun/guardian-cli/blob/HEAD/tools/README.md)** — Обзор интегрированных инструментов

### Обзор архитектуры```
Guardian Architecture:
┌─────────────────────────────────────────┐
│         AI Provider Layer               │
│  (OpenAI, Claude, Gemini, OpenRouter,   │
│   Requesty)                             │
└─────────────────────────────────────────┘
                 │
┌─────────────────────────────────────────┐
│       Multi-Agent System                │
│  Planner → Tool Agent → Analyst →      │
│            Reporter                      │
└─────────────────────────────────────────┘
                 │
┌─────────────────────────────────────────┐
│      Workflow Engine                    │
│  - Parameter Priority                   │
│  - Evidence Capture                     │
│  - Session Management                   │
└─────────────────────────────────────────┘
                 │
┌─────────────────────────────────────────┐
│      Tool Integration Layer             │
│  (19 Security Tools)                    │
└─────────────────────────────────────────┘

---

## 🆕 Последние обновления

### Версия 4.0.0 — Новые исследования и расширение покрытия

**Трек A — ИИ/Агентские исследования (7 пунктов)**

| ID | Элемент | Особенности |
|---|---|---|
| A1 | RAG база знаний | `core/knowledge_base.py` SQLite + FTS5 + optional embeddings; обоснование аналитика через слот `kb_references`; `guardian kb {seed,update,query,status}` |
| A2 | Многоагентная дебатная триажа | Красный/Синий/Судья только для находок MEDIUM-fp; новый тип шага анализа `agent: debate` |
| A3 | Анализ скриншотов с помощью Vision-LLM | `tools/playwright_screenshot.py` + `core/agents/visual_triage.py`; OpenAI + Claude `generate_with_images` |
| A4 | Контракт плагинов + локальные провайдеры | Обнаружение точек входа для провайдеров И инструментов; поставляются провайдеры **Ollama** + **OpenAI-совместимые** |
| A5 | Обученный выбор инструментов (офлайн) | `core/learners/tool_ranker.py` + `core/telemetry.py`; опционально через `ai.use_learned_ranker: true` |
| A6 | Оценочная обвязка | `evals/{__init__,scoring,fixtures_loader,test_*}.py` + золотые фикстуры; 3 уровня (парсер, workflow, обоснование агента) |
| A7 | Обновление модели судьи | `BaseAgent.think_deeply(judge_model=...)` — замена и восстановление; оценка транскриптов для снижения затрат ~в 10 раз |

**Трек B — Расширение покрытия инструментов (7 пунктов)**

| ID | Категория | Добавленные инструменты |
|---|---|---|
| B8 | Active Directory | crackmapexec, bloodhound, kerbrute, impacket-secretsdump |
| B9 | Мобильные Android | mobsf, apkleaks, objection |
| B10 | Фаззеры API | schemathesis, restler, cariddi |
| B11 | SAST + секреты | semgrep, trufflehog, dependency-check |
| B12 | Red-team для LLM | garak, pyrit, prompt_fuzz |
| B13 | Мост Burp/ZAP | zap, burp |
| B14 | Экспортеры вывода | SARIF v2.1.0, DefectDojo, Slack |

**Планка качества:**
- 296 тестов проходят (+93% от базового значения v3 в 153)
- Все закалки v3 сохранены: разделители для инъекций подсказок, очистка ключей, область разрешения DNS, атомарные контрольные точки, ротация логов, ленивая загрузка инструментов
- Время запуска `guardian --help` остаётся <500 мс, несмотря на 50 инструментов
- Новые CLI поверхности: `guardian kb`, `guardian telemetry`
- 8 новых поставляемых workflow: `web_pentest_with_debate`, `web_visual_pentest`, `ad_assessment`, `mobile_android`, `llm_redteam`, `sast_review`, `api_pentest_v2`, плюс существующие workflow v3

### Версия 3.0.0 — Закалка + Engine v2

- Разделители для инъекций подсказок (`<UNTRUSTED_TOOL_OUTPUT>`) на всех выводах инструментов
- DAG планировщик, Pydantic схемы, атомарные контрольные точки, `--resume`
- 11 новых обёрток (облако/контейнер/SBOM/GraphQL/JWT/OSINT)
- Пересчёт CVSS v3.1 + обнаружение дрейфа
- Ротация логов, очистка ключей при записи
- Подтверждающий шлюз, подключённый для активных+ инструментов

### Версия 2.0.0

- Многопровайдерный ИИ (OpenAI, Claude, Gemini, OpenRouter, Requesty)
- Связывание доказательств через `execution_id`
- Система приоритетов параметров workflow

---

## 🤝 Вклад

Мы приветствуем вклад! Вот как:

### Настройка среды разработки```bash
# Fork and clone
git clone https://github.com/zakirkun/guardian-cli.git
cd guardian-cli

# Install dev dependencies
pip install -e ".[dev]"

# Run tests
pytest tests/

# Format code
black .

**Ошибки поставщика ИИ**```bash
# Verify API key is set
python -m cli.main models

# Check provider configuration
cat config/guardian.yaml | grep -A 5 "ai:"

**Рабочий процесс не загружается**```bash
# Check workflow file exists
ls workflows/web_pentest.yaml

# Verify YAML syntax
python -c "import yaml; yaml.safe_load(open('workflows/web_pentest.yaml'))"

Для получения дополнительной помощи, [создайте issue](https://github.com/zakirkun/guardian-cli/issues).

---

## 📄 License

Этот проект лицензирован по лицензии MIT - подробности см. в файле [LICENSE](https://github.com/zakirkun/guardian-cli/blob/HEAD/LICENSE).

---

## 🙏 Благодарности

- **OpenAI** - возможности GPT-4
- **Anthropic** - Claude AI
- **Google** - Gemini AI
- **LangChain** - фреймворк оркестрации ИИ
- **ProjectDiscovery** - инструменты безопасности с открытым исходным кодом (httpx, subfinder, nuclei)
- **Nmap** - исследование сети и аудит безопасности
- **The Security Community** - разработчики и исследователи инструментов

---

## 📞 Поддержка и контакты

- **GitHub Issues**: [Сообщить об ошибках или запросить функции](https://github.com/zakirkun/guardian-cli/issues)
- **Discussions**: [Присоединиться к обсуждениям сообщества](https://github.com/zakirkun/guardian-cli/discussions)
- **Documentation**: [Читать документацию](https://github.com/zakirkun/guardian-cli/blob/HEAD/docs/)
- **Security**: Сообщайте об уязвимостях конфиденциально на [email protected]

---

## 🌟 Star History

<a href="https://github.com/zakirkun/guardian-cli/stargazers">
  <picture>
    <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=zakirkun/guardian-cli&type=Date&theme=dark" />
    <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=zakirkun/guardian-cli&type=Date" />
    Star History Chart
  </picture>
</a>

---
---

<div align="center">

**Guardian** - Умное, этичное, автоматизированное тестирование на проникновение

Сделано с ❤️ сообществом безопасности

[⬆ Наверх](#-guardian)

</div>