Quick start

Быстрый старт

1. Откройте Git-репозиторий

cd my-project

Убедитесь, что это Git-репозиторий:

git status

2. Установите hook

custodes init

Custodes создаст файл .git/hooks/pre-commit. Теперь проверка будет запускаться перед каждым обычным коммитом.

3. Настройте правила

Откройте конфигурацию:

custodes config

Минимальный пример:

banwords=API_KEY,SECRET_TOKEN,password
logo_custodes=yes
output_violations=yes
lang_custodes=ru

Подробнее: Конфигурация.

4. Проверьте блокировку

Добавьте в тестовый файл строку, содержащую одно из запрещённых значений:

API_KEY=test-value

Подготовьте файл и попробуйте выполнить коммит:

git add test-file
git commit -m "test Custodes"

Custodes должен вывести предупреждение и завершиться с кодом 1. Git остановит коммит.

5. Исправьте нарушение

Удалите секрет или вынесите значение в безопасное хранилище, затем снова подготовьте файл:

git add test-file
git commit -m "remove secret"

Если совпадений больше нет, коммит будет создан.

Ручная проверка

Проверку можно запустить без попытки коммита:

custodes check

Custodes анализирует только изменения, уже добавленные через git add. Неподготовленные изменения не проверяются.