Комплексная проверка проекта (chutils check / chutils doctor)
Команда chutils check (или её псевдоним chutils doctor) является единой точкой входа для комплексного аудита
вашего проекта.
Она объединяет три ранее разрозненных этапа проверки в единый понятный отчет:
- 🏥 Системный Health Check (состояние окружения, ключница keyring, доступность путей).
- 📐 Валидация Pydantic-конфигурации (соответствие
config.ymlвашей моделиSettings). - 🤖 Аудит AI-готовности (проверка правил
ai-lintдля работы с кодинг-агентами).
Синтаксис
chutils check [-h] [--config] [--lint] [--system] [-m MODEL] [--json]
Также поддерживается короткий псевдоним:
chutils doctor [-h] [--config] [--lint] [--system] [-m MODEL] [--json]
Параметры и флаги:
| Флаг | Описание | Обязательный |
|---|---|---|
--config |
Запустить только валидацию Pydantic-конфигурации. | Нет |
--lint, --ai |
Запустить только аудит AI-готовности кодовой базы (ai-lint). |
Нет |
--system, --health |
Запустить только системный Health Check среды (keyring, конфигурация, кастомные проверки). | Нет |
-m, --model |
Путь к Pydantic-модели (например, myapp.config:Settings). Если опущен, выполняется авто-поиск Settings. |
Нет |
--json |
Сформировать единый машиночитаемый отчёт в формате JSON. | Нет |
Как это работает?
При запуске без дополнительных сфокусированных флагов утилита последовательно выполняет 3 этапа:
=== Комплексная проверка проекта (chutils check) ===
1. Системный Health Check:
Статус системы: HEALTHY
Успешных проверок: 5/5
2. Валидация конфигурации Pydantic:
✓ Конфигурация успешно прошла валидацию по модели 'src.config:Settings'
3. Аудит AI-готовности (ai-lint):
✓ Все проверки AI-готовности пройдены!
Вывод: Все проверенные компоненты проекта в порядке!
В случае обнаружения критических ошибок на любом из этапов команда завершается с Exit Code 1, что делает ее идеальной для автоматических CI/CD пайплайнов и Git-хуков.
Примеры использования
1. Полная диагностика проекта (рекомендуемый вариант)
chutils check
# или
chutils doctor
2. Проверка только AI-готовности кодовой базы
chutils check --lint
3. Проверка конфигурации с явным указанием Pydantic-модели
chutils check --config -m myapp.settings:AppConfig
4. Экспорт отчета в формате JSON для CI/CD или мониторинга
chutils check --json
Связанные команды
validate— Узконаправленная валидация только Pydantic-модели.dev ai-lint— Детальный статический анализ и настройка правил для AI-ассистентов.dev diagnostics— Низкоуровневая диагностика с выводом подробных таблиц проверок.