Интерфейс командной строки (CLI)
Библиотека chutils поставляется с мощной консольной утилитой chutils, которая автоматизирует рутинные задачи
настройки проекта, управления секретами, генерации шаблонов конфигурации и подготовки контекста для AI-ассистентов.
Установка
Инструмент командной строки становится доступен сразу после установки библиотеки в виртуальное окружение:
pip install chutils
Если вы используете опциональные зависимости (например, Pydantic или шифрование секретов), рекомендуется устанавливать пакет с соответствующими extras:
pip install chutils[full]
Базовый синтаксис
Общий формат запуска команд выглядит следующим образом:
chutils [GLOBAL_OPTIONS] COMMAND [COMMAND_OPTIONS] [ARGS...]
Глобальные флаги
-h, --help— Показать справочное сообщение и список доступных команд.-v, --version— Вывести текущую версию утилитыchutils.
Список команд
Ниже представлена общая таблица доступных команд chutils:
| Команда | Описание | Ссылка на подробное руководство |
|---|---|---|
init |
Инициализация структуры проекта и генерация файлов конфигурации | Инициализация (init.md) |
secrets |
Безопасное сохранение и удаление секретов в системном хранилище (keyring) | Управление секретами (secrets.md) |
validate |
Проверка валидности текущих настроек по Pydantic-модели | Валидация (validate.md) |
env |
Декларативная валидация переменных окружения по манифесту | Валидация окружения (env.md) |
show-paths |
Отображение списка путей поиска конфигурационных файлов | Пути поиска (show_paths.md) |
template |
Генерация шаблонов (config.yml, .env, JSON Schema) на базе Pydantic-моделей |
Генерация шаблонов (template.md) |
config |
Интерактивная отладка и генерация JSON-схемы конфигурации | Настройки и отладка (config.md) |
dev |
Построение карты публичного API и аудит AI-готовности кодовой базы | Инструменты разработчика (dev.md) |
pypi |
Проверка доступности и измерение скорости скачивания зеркал PyPI | Проверка зеркал (pypi.md) |
db |
Управление миграциями баз данных (Alembic wrapper) | Управление миграциями (db.md) |
Получение справки по конкретной команде
Для получения подробной информации по аргументам и флагам конкретной команды запустите её с флагом --help:
chutils config --help
chutils secrets set --help