Skip to content

🛠️ CLI

⬅️ Back | 🏠 Docs Root

Модуль cli предоставляет интерфейс командной строки для быстрой разработки фич и генерации структуры проекта в фреймворке codex-bot.


🧠 Почему так?

Стандартизированная генерация (Scaffolding)

В архитектуре, основанной на фичах, каждый модуль должен следовать строгой структуре директорий (handlers, logic, ui, resources и т.д.). Ручное создание этих папок и файлов утомительно и чревато ошибками. CLI codex-bot автоматизирует этот процесс, гарантируя, что каждая новая фича с самого начала соответствует стандартам фреймворка.

Быстрое прототипирование

Используя заранее определенные шаблоны, разработчики могут за считанные секунды создать полностью функциональную фичу "Hello World" (включая FSM-состояния, клавиатуры и оркестраторы). Это позволяет быстрее итерировать и прототипировать новые возможности бота.


🔄 Поток данных (The Flow)

  1. Команда: Разработчик запускает codex-bot create-feature <name> [--type redis].
  2. Загрузка шаблонов: CLI загружает соответствующие файлы .py.tpl из внутренней директории templates библиотеки.
  3. Инъекция переменных: CLI подставляет имя фичи, имена классов и ключи в шаблоны.
  4. Создание файлов: В папке проекта features/ создается новая структура директорий, заполненная сгенерированными файлами.
  5. Интеграция: Разработчику предлагается добавить путь к новой фиче в список INSTALLED_FEATURES в настройках.

🗺️ Карта модуля

Компонент Описание
📄 API Reference Технические детали CLI-команд.
📄 create-feature Команда генерации структуры новой фичи.

Последнее обновление: 2025-02-07