Справочник команд CLI
Интерфейс командной строки sd предоставляет 27 подкоманд, организованных в 10 категорий. Эта страница служит кратким справочным указателем. Каждая команда ссылается на свою подробную страницу документации там, где она доступна.
Глобальные параметры
Эти флаги можно передавать любой подкоманде:
| Флаг | По умолчанию | Описание |
|---|---|---|
--log-level <LEVEL> | warn | Уровень подробности логирования: trace, debug, info, warn, error |
--data-dir <PATH> | ~/.prx-sd | Базовый каталог данных для сигнатур, карантина, конфигурации и плагинов |
--help | -- | Показать справку по любой команде или подкоманде |
--version | -- | Показать версию движка |
# Включить отладочное логирование
sd --log-level debug scan /tmp
# Использовать пользовательский каталог данных
sd --data-dir /opt/prx-sd scan /homeСканирование
Команды для сканирования файлов и системы по запросу.
| Команда | Описание |
|---|---|
sd scan <PATH> | Сканировать файл или каталог на угрозы |
sd scan-memory | Сканировать память запущенных процессов (только Linux, требует root) |
sd scan-usb [DEVICE] | Сканировать USB/съёмные устройства |
sd check-rootkit | Проверить наличие индикаторов руткитов (только Linux) |
# Рекурсивное сканирование каталога с автокарантином
sd scan /home --auto-quarantine
# Сканирование с выводом JSON для автоматизации
sd scan /tmp --json
# Сканирование с 4 потоками и HTML-отчётом
sd scan /var --threads 4 --report /tmp/report.html
# Исключение паттернов
sd scan /home --exclude "*.log" --exclude "/home/user/.cache"
# Сканирование с автоустранением (завершить процесс, поместить в карантин, очистить persistence)
sd scan /tmp --remediate
# Сканирование памяти процессов
sudo sd scan-memory
sudo sd scan-memory --pid 1234
# Сканирование USB-устройств
sd scan-usb
sd scan-usb /dev/sdb1 --auto-quarantine
# Проверка на руткиты
sudo sd check-rootkit
sudo sd check-rootkit --jsonМониторинг в реальном времени
Команды для непрерывного мониторинга файловой системы и работы фонового демона.
| Команда | Описание |
|---|---|
sd monitor <PATHS...> | Запустить мониторинг файловой системы в реальном времени |
sd daemon [PATHS...] | Запустить как фоновый демон с мониторингом и автообновлением |
# Мониторинг /home и /tmp на изменения
sd monitor /home /tmp
# Мониторинг с режимом блокировки (fanotify, требует root)
sudo sd monitor /home --block
# Запуск как демон с путями по умолчанию (/home, /tmp)
sd daemon
# Демон с пользовательским интервалом обновления (каждые 2 часа)
sd daemon /home /tmp /var --update-hours 2Управление карантином
Команды для управления зашифрованным хранилищем карантина AES-256-GCM.
| Команда | Описание |
|---|---|
sd quarantine list | Список всех файлов в карантине |
sd quarantine restore <ID> | Восстановить файл из карантина в исходное расположение |
sd quarantine delete <ID> | Навсегда удалить файл из карантина |
sd quarantine delete-all | Навсегда удалить все файлы из карантина |
sd quarantine stats | Показать статистику хранилища карантина |
# Список файлов в карантине
sd quarantine list
# Восстановить файл (используйте первые 8 символов ID)
sd quarantine restore a1b2c3d4
# Восстановить по альтернативному пути
sd quarantine restore a1b2c3d4 --to /tmp/recovered/
# Удалить конкретную запись
sd quarantine delete a1b2c3d4
# Удалить все записи (с запросом подтверждения)
sd quarantine delete-all
# Удалить все без подтверждения
sd quarantine delete-all --yes
# Просмотр статистики карантина
sd quarantine statsУправление сигнатурами
Команды для обновления и импорта сигнатур угроз.
| Команда | Описание |
|---|---|
sd update | Проверить и применить обновления базы данных сигнатур |
sd import <FILE> | Импортировать хеш-сигнатуры из файла-списка блокировок |
sd import-clamav <FILES...> | Импортировать файлы сигнатур ClamAV (.cvd, .hdb, .hsb) |
sd info | Отобразить версию движка, статус сигнатур и системную информацию |
# Обновить сигнатуры
sd update
# Проверить наличие обновлений без скачивания
sd update --check-only
# Принудительное повторное скачивание
sd update --force
# Импортировать пользовательский файл хешей
sd import /path/to/hashes.txt
# Импортировать сигнатуры ClamAV
sd import-clamav main.cvd daily.cvd
# Показать информацию о движке
sd infoКонфигурация
Команды для управления конфигурацией движка и политикой устранения угроз.
| Команда | Описание |
|---|---|
sd config show | Отобразить текущую конфигурацию |
sd config set <KEY> <VALUE> | Установить значение конфигурации |
sd config reset | Сбросить конфигурацию до значений по умолчанию |
sd policy show | Отобразить политику устранения угроз |
sd policy set <KEY> <VALUE> | Установить значение политики устранения угроз |
sd policy reset | Сбросить политику устранения угроз до значений по умолчанию |
# Показать конфигурацию
sd config show
# Установить потоки сканирования
sd config set scan.threads 8
# Сбросить до значений по умолчанию
sd config reset
# Показать политику устранения угроз
sd policy showПодробнее см. в обзоре конфигурации и справочнике конфигурации.
Запланированные сканирования
Команды для управления повторяющимися запланированными сканированиями через таймеры systemd или cron.
| Команда | Описание |
|---|---|
sd schedule add <PATH> | Зарегистрировать повторяющееся запланированное сканирование |
sd schedule remove | Удалить запланированное сканирование |
sd schedule status | Показать текущий статус расписания |
# Запланировать еженедельное сканирование /home
sd schedule add /home --frequency weekly
# Запланировать ежедневное сканирование
sd schedule add /var --frequency daily
# Доступные частоты: hourly, 4h, 12h, daily, weekly
sd schedule add /tmp --frequency 4h
# Удалить расписание
sd schedule remove
# Проверить статус расписания
sd schedule statusОповещения и вебхуки
Команды для настройки уведомлений о предупреждениях через вебхуки и электронную почту.
| Команда | Описание |
|---|---|
sd webhook list | Список настроенных конечных точек вебхуков |
sd webhook add <NAME> <URL> | Добавить конечную точку вебхука |
sd webhook remove <NAME> | Удалить конечную точку вебхука |
sd webhook test | Отправить тестовое оповещение на все вебхуки |
sd email-alert configure | Настроить оповещения по электронной почте через SMTP |
sd email-alert test | Отправить тестовое оповещение по электронной почте |
sd email-alert send <NAME> <LEVEL> <PATH> | Отправить пользовательское оповещение по электронной почте |
# Добавить вебхук Slack
sd webhook add my-slack https://hooks.slack.com/services/... --format slack
# Добавить вебхук Discord
sd webhook add my-discord https://discord.com/api/webhooks/... --format discord
# Добавить общий вебхук
sd webhook add my-webhook https://example.com/webhook
# Список всех вебхуков
sd webhook list
# Проверить все вебхуки
sd webhook test
# Настроить оповещения по электронной почте
sd email-alert configure
# Проверить оповещения по электронной почте
sd email-alert testСетевая защита
Команды для блокировки рекламы и вредоносных доменов на уровне DNS.
| Команда | Описание |
|---|---|
sd adblock enable | Включить защиту adblock через файл hosts |
sd adblock disable | Отключить защиту adblock |
sd adblock sync | Повторно скачать все списки фильтров |
sd adblock stats | Показать статистику движка adblock |
sd adblock check <URL> | Проверить, заблокированы ли URL/домен |
sd adblock log | Показать последние заблокированные записи |
sd adblock add <NAME> <URL> | Добавить пользовательский список фильтров |
sd adblock remove <NAME> | Удалить список фильтров |
sd dns-proxy | Запустить локальный DNS-прокси с фильтрацией |
# Включить adblock
sudo sd adblock enable
# Запустить DNS-прокси
sudo sd dns-proxy --listen 127.0.0.1:53 --upstream 1.1.1.1:53Подробнее см. в Adblock и DNS-прокси.
Отчётность
| Команда | Описание |
|---|---|
sd report <OUTPUT> | Создать HTML-отчёт из результатов сканирования JSON |
# Сканирование с выводом JSON, затем создание HTML-отчёта
sd scan /home --json > results.json
sd report report.html --input results.json
# Или использовать флаг --report напрямую
sd scan /home --report /tmp/scan-report.htmlСистема
Команды для обслуживания движка, интеграции и самообновления.
| Команда | Описание |
|---|---|
sd status | Показать статус демона (запущен/остановлен, PID, заблокированные угрозы) |
sd install-integration | Установить интеграцию сканирования правой кнопкой мыши в файловый менеджер |
sd self-update | Проверить и применить обновления бинарного файла движка |
# Проверить статус демона
sd status
# Установить интеграцию рабочего стола
sd install-integration
# Проверить наличие обновлений движка
sd self-update --check-only
# Применить обновление движка
sd self-updateСообщество
Команды для обмена разведкой угроз с сообществом.
| Команда | Описание |
|---|---|
sd community status | Показать конфигурацию обмена с сообществом |
sd community enroll | Зарегистрировать эту машину в API сообщества |
sd community disable | Отключить обмен с сообществом |
# Проверить статус регистрации
sd community status
# Зарегистрироваться в обмене с сообществом
sd community enroll
# Отключить обмен (учётные данные сохраняются)
sd community disableСледующие шаги
- Начните с руководства по быстрому старту для начала сканирования за 5 минут
- Изучите конфигурацию для настройки поведения движка
- Настройте мониторинг в реальном времени для непрерывной защиты
- Узнайте о конвейере движка обнаружения