-
Notifications
You must be signed in to change notification settings - Fork 0
CLI reference
Общий формат:
custodes <command>Custodes принимает ровно одну команду за один запуск.
| Команда | Короткая форма | Назначение |
|---|---|---|
help |
-h |
Показать встроенную справку |
init |
-i |
Установить Custodes hook в текущий Git-репозиторий |
check |
-ch |
Вручную проверить staged-изменения |
status |
-s |
Сравнить установленную версию с веткой release
|
update |
-up |
Обновить Custodes из ветки release
|
config |
-cfg |
Открыть .env в редакторе nano
|
remove |
-r |
Удалить pre-commit hook из текущего репозитория |
uninstall |
-un |
Удалить глобальную установку Custodes |
about |
-a |
Показать сведения о проекте |
Создаёт .git/hooks/pre-commit со следующим вызовом:
custodes checkЕсли pre-commit уже существует, Custodes остановится и не перезапишет его. Автоматическое объединение с существующим hook пока не поддерживается.
Запускает Python-сканер и возвращает:
-
0, если совпадений нет; -
1, если обнаружена запрещённая строка или конфигурация некорректна.
Читает текущую версию из установленного README.md, затем получает версию из README.md ветки release. Для команды нужен доступ к GitHub.
Клонирует ветку release во временный каталог, обновляет зависимости и заменяет файлы программы. При обновлении сохраняются:
-
~/.local/share/custodes/.env; -
~/.local/share/custodes/.venv.
Открывает файл:
~/.local/share/custodes/.env
Текущая реализация использует nano, поэтому редактор должен быть установлен.
Удаляет .git/hooks/pre-commit в текущем репозитории после подтверждения.
Перед подтверждением убедитесь, что этот hook действительно был создан Custodes: текущая версия удаляет файл целиком и не проверяет его содержимое.
Удаляет:
~/.local/share/custodes/
~/.local/bin/custodes
Hooks в отдельных репозиториях остаются. Выполните custodes remove в них до глобального удаления.