🏠 Главная › Документация › Разработчикам

Расширение CLI

Hermes предоставляет защищённые хуки расширения в HermesCLI, чтобы обёрточные CLI могли добавлять виджеты, привязки клавиш и настройки макета без переопределения метода run() размером более 1000 строк. Это сохраняет ваше расширение независимым от внутренних изменений.

Точки расширения

Доступно пять точек расширения:

Хук Назначение Переопределять, когда...
_get_extra_tui_widgets() Внедрение виджетов в макет Нужен постоянный элемент UI (панель, строка состояния, мини-плеер)
_register_extra_tui_keybindings(kb, *, input_area) Добавление горячих клавиш Нужны хоткеи (переключение панелей, элементы управления, модальные комбинации)
_build_tui_layout_children(**widgets) Полный контроль над порядком виджетов Нужно изменить порядок или обернуть существующие виджеты (редко)
process_command() Добавление пользовательских слэш-команд Нужна обработка /mycommand (существующий хук)
_build_tui_style_dict() Пользовательские стили prompt_toolkit Нужны собственные цвета или стили (существующий хук)

Первые три — новые защищённые хуки. Последние два уже существовали.

Быстрый старт: обёрточный CLI

#!/usr/bin/env python3
"""my_cli.py — Example wrapper CLI that extends Hermes."""

from cli import HermesCLI
from prompt_toolkit.layout import FormattedTextControl, Window
from prompt_toolkit.filters import Condition


class MyCLI(HermesCLI):

    def __init__(self, **kwargs):
        super().__init__(**kwargs)
        self._panel_visible = False

    def _get_extra_tui_widgets(self):
        """Add a toggleable info panel above the status bar."""
        cli_ref = self
        return [
            Window(
                FormattedTextControl(lambda: "📊 My custom panel content"),
                height=1,
                filter=Condition(lambda: cli_ref._panel_visible),
            ),
        ]

    def _register_extra_tui_keybindings(self, kb, *, input_area):
        """F2 toggles the custom panel."""
        cli_ref = self

        @kb.add("f2")
        def _toggle_panel(event):
            cli_ref._panel_visible = not cli_ref._panel_visible

    def process_command(self, cmd: str) -> bool:
        """Add a /panel slash command."""
        if cmd.strip().lower() == "/panel":
            self._panel_visible = not self._panel_visible
            state = "visible" if self._panel_visible else "hidden"
            print(f"Panel is now {state}")
            return True
        return super().process_command(cmd)


if __name__ == "__main__":
    cli = MyCLI()
    cli.run()

Запуск:

cd ~/.hermes/hermes-agent
source .venv/bin/activate
python my_cli.py

Справочник хуков

_get_extra_tui_widgets()

Возвращает список виджетов prompt_toolkit для вставки в TUI-макет. Виджеты располагаются между разделителем и строкой состояния — выше области ввода, но ниже основного вывода.

def _get_extra_tui_widgets(self) -> list:
    return []  # default: no extra widgets

Каждый виджет должен быть контейнером prompt_toolkit (например, Window, ConditionalContainer, HSplit). Используйте ConditionalContainer или filter=Condition(...), чтобы сделать виджеты переключаемыми.

from prompt_toolkit.layout import ConditionalContainer, Window, FormattedTextControl
from prompt_toolkit.filters import Condition

def _get_extra_tui_widgets(self):
    return [
        ConditionalContainer(
            Window(FormattedTextControl("Status: connected"), height=1),
            filter=Condition(lambda: self._show_status),
        ),
    ]

_register_extra_tui_keybindings(kb, *, input_area)

Вызывается после регистрации собственных привязок клавиш Hermes и до построения макета. Добавляйте свои привязки клавиш в kb.

def _register_extra_tui_keybindings(self, kb, *, input_area):
    pass  # default: no extra keybindings

Параметры:

def _register_extra_tui_keybindings(self, kb, *, input_area):
    cli_ref = self

    @kb.add("f3")
    def _clear_input(event):
        input_area.text = ""

    @kb.add("f4")
    def _insert_template(event):
        input_area.text = "/search "

Избегайте конфликтов со встроенными привязками клавиш: Enter (отправка), Escape Enter (новая строка), Ctrl-C (прерывание), Ctrl-D (выход), Tab (автодополнение). Функциональные клавиши F2+ и комбинации с Ctrl обычно безопасны.

_build_tui_layout_children(**widgets)

Переопределяйте этот метод только когда нужен полный контроль над порядком виджетов. Большинству расширений достаточно использовать _get_extra_tui_widgets().

def _build_tui_layout_children(self, *, sudo_widget, secret_widget,
    approval_widget, clarify_widget, model_picker_widget=None,
    spinner_widget=None, spacer, status_bar, input_rule_top,
    image_bar, input_area, input_rule_bot, voice_status_bar,
    completions_menu) -> list:

Реализация по умолчанию возвращает (виджеты со значением None отфильтровываются):

[
    Window(height=0),       # anchor
    sudo_widget,            # sudo password prompt (conditional)
    secret_widget,          # secret input prompt (conditional)
    approval_widget,        # dangerous command approval (conditional)
    clarify_widget,         # clarify question UI (conditional)
    model_picker_widget,    # model picker overlay (conditional)
    spinner_widget,         # thinking spinner (conditional)
    spacer,                 # fills remaining vertical space
    *self._get_extra_tui_widgets(),  # YOUR WIDGETS GO HERE
    status_bar,             # model/token/context status line
    input_rule_top,         # ─── border above input
    image_bar,              # attached images indicator
    input_area,             # user text input
    input_rule_bot,         # ─── border below input
    voice_status_bar,       # voice mode status (conditional)
    completions_menu,       # autocomplete dropdown
]

Схема макета

Макет по умолчанию сверху вниз:

  1. Область вывода — прокручиваемая история диалога

  2. Разделитель

  3. Дополнительные виджеты — из _get_extra_tui_widgets()

  4. Строка состояния — модель, % контекста, прошедшее время

  5. Панель изображений — количество прикреплённых изображений

  6. Область ввода — пользовательский запрос

  7. Статус голоса — индикатор записи

  8. Меню автодополнения — подсказки автодополнения

Советы