Home

Custodes Wiki

Custodes — локальный CLI-инструмент, который проверяет подготовленные (staged) изменения перед Git-коммитом и блокирует коммит при обнаружении запрещённых строк.

Custodes устанавливает pre-commit hook в выбранный репозиторий и запускает проверку автоматически при git commit. Правила поиска задаются пользователем в файле .env.

С чего начать

1. Установите Custodes.
2. Перейдите в нужный Git-репозиторий.
3. Выполните custodes init.
4. Настройте список banwords.
5. Проверьте работу по инструкции Быстрый старт.

Возможности

• проверка только подготовленных изменений из Git index;
• запуск вручную или через pre-commit hook;
• настраиваемый список запрещённых строк;
• вывод файлов и строк с совпадениями;
• русский и английский язык сообщений;
• проверка версии и обновление из ветки release;
• удаление hook из отдельного репозитория и полное удаление программы.

Навигация

• Установка
• Быстрый старт
• Команды CLI
• Конфигурация
• Как работает Custodes
• Решение проблем
• Ограничения и планы

Важно

Custodes — учебный pet-project и дополнительный локальный защитный слой. Он не заменяет Gitleaks, TruffleHog, серверное сканирование секретов или проверку в CI/CD.

Проект: https://github.com/No1se-pi/Custodes

Сайт: https://no1se-pi.github.io/Custodes/