Перейти к содержанию

Команды

Koda CLI поддерживает несколько встроенных команд, которые помогают вам управлять сессией, настраивать интерфейс и контролировать его поведение. Эти команды начинаются с косой черты (/), символа @ (@) или восклицательного знака (!).

Команды с косой чертой (/)

Команды с косой чертой предоставляют мета-уровень управления самим CLI.

Встроенные команды

  • /bug

  • Описание: Сообщить о проблеме с Koda CLI. По умолчанию открывается Telegram канал с сообществом, где вы сможете задать свой вопрос и информация о запущенном окружении.

  • /chat

  • Описание: Сохраняйте и возобновляйте историю переписки для разветвления состояния переписки интерактивно или возобновления предыдущего состояния из более поздней сессии.

  • Подкоманды:

    • save
    • Описание: Сохраняет текущую историю переписки. Вы должны добавить <тег> для идентификации состояния переписки.
    • Использование: /chat save <тег>
    • Сведения о расположении контрольных точек: По умолчанию сохраненные контрольные точки переписки находятся в:
      • Linux/macOS: ~/.kodacli/tmp/<хеш_проекта>/checkpoints/
      • Windows: C:\\Users\\<ВашеИмяПользователя>\\.gemini\\tmp\\<хеш_проекта>\\checkpoints\\
      • При выполнении /chat list CLI сканирует только эти конкретные каталоги, чтобы найти доступные контрольные точки.
      • Примечание: Эти контрольные точки предназначены для ручного сохранения и восстановления состояний переписки. Для автоматических контрольных точек, создаваемых перед изменением файлов, см. документацию по контрольным точкам.
    • resume
    • Описание: Возобновляет переписку из предыдущего сохранения.
    • Использование: /chat resume <тег>
    • list
    • Описание: Перечисляет доступные теги для восстановления состояния переписки.
    • delete
    • Описание: Удаляет сохраненную контрольную точку переписки.
    • Использование: /chat delete <тег>

  • /clear

  • Описание: Очищает экран терминала, включая видимую историю сеанса и буфер прокрутки в CLI. В зависимости от реализации, основные данные сеанса (для вызова истории) могут сохраняться, но визуальное отображение очищается.

  • Сочетание клавиш: Нажмите Ctrl+L в любое время, чтобы выполнить очистку.

  • /compress

  • Описание: Заменить весь контекст чата резюме. Это экономит токены, используемые для последующих задач, сохраняя при этом краткое резюме произошедшего.

  • /copy

  • Описание: Копирует последний вывод, созданный Koda CLI, в ваш буфер обмена для легкого обмена или повторного использования.

  • /directory (или /dir)

  • Описание: Управление каталогами рабочей области для поддержки нескольких каталогов.

  • Подкоманды:

    • add:
    • Описание: Добавить каталог в рабочую область. Путь может быть абсолютным или относительным к текущему рабочему каталогу. Также поддерживается ссылка из домашнего каталога.
    • Использование: /directory add <path1>,<path2>
    • Примечание: Отключено в ограничительных профилях песочницы. Если вы используете их, используйте --include-directories при запуске сессии вместо этого.
    • show:
    • Описание: Показать все каталоги, добавленные с помощью /directory add и --include-directories.
    • Использование: /directory show

  • /editor

  • Описание: Открыть диалог для выбора поддерживаемых редакторов.

  • /help (или /?)

  • Описание: Отобразить справочную информацию о Koda CLI, включая доступные команды и их использование.

  • /mcp

  • Описание: Перечислить настроенные серверы протокола контекста моделей (MCP), их статус подключения, сведения о сервере и доступные инструменты.
  • Подкоманды:
    • desc или descriptions:
    • Описание: Показать подробные описания серверов MCP и инструментов.
    • nodesc или nodescriptions:
    • Описание: Скрыть описания инструментов, показывая только их названия.
    • schema:
    • Описание: Показать полную схему JSON для настроенных параметров инструмента.

  • Сочетание клавиш: Нажмите Ctrl+T в любое время, чтобы переключиться между показом и скрытием описаний инструментов.

  • /memory

  • Описание: Управление контекстом инструкций ИИ (иерархическая память, загруженная из файлов KODA.md).

  • Подкоманды:

    • add:
    • Описание: Добавляет следующий текст в память ИИ. Использование: /memory add <текст для запоминания>
    • show:
    • Описание: Отобразить полное объединенное содержимое текущей иерархической памяти, которое было загружено из всех файлов KODA.md. Это позволяет вам проверить контекст инструкций, предоставляемый модели Koda.
    • refresh:
    • Описание: Перезагрузить иерархическую инструктивную память из всех файлов KODA.md, найденных в настроенных местоположениях (глобальных, проектных/предков и подкаталогов). Эта команда обновляет модель последним содержимым KODA.md.

  • /restore

  • Описание: Восстанавливает файлы проекта в состояние, в котором они находились непосредственно перед выполнением инструмента. Это особенно полезно для отмены изменений файлов, сделанных инструментом. Если запустить без ID вызова инструмента, он выведет список доступных контрольных точек для восстановления.
  • Использование: /restore [tool_call_id]

  • Примечание: Доступно только если CLI вызывается с опцией --checkpointing. См. документацию о контрольных точках для более подробной информации.

  • /settings

  • Описание: Открыть редактор настроек для просмотра и изменения настроек Koda CLI.
  • Подробности: Эта команда предоставляет удобный интерфейс для изменения настроек, управляющих поведением и внешним видом Koda CLI.

  • Использование: Просто запустите /settings, и откроется меню.

  • /stats

  • Описание: Отобразить подробную статистику для текущего сеанса Koda CLI, включая использование токенов и продолжительность сеанса.

  • /limits

  • Описание: Показать лимиты по моделям для текущей авторизации Koda Auth. Доступна только после входа через Koda Auth.

  • /theme

  • Описание: Открыть диалог, который позволяет изменить визуальную тему Koda CLI.

  • /auth

  • Описание: Открыть диалог, который позволяет изменить метод аутентификации.

  • /model

  • Описание: Выберите модель, которую использует CLI, и область применения изменения (пользовательские, рабочие или системные настройки). Используйте Enter для выбора модели и Tab для переключения области.
  • Добавить свою модель (OpenAI-совместимую):
    • Выберите пункт [+] Add custom model (OpenAI-compatible) внизу списка.
    • Укажите идентификатор модели, базовый URL провайдера (по умолчанию https://api.openai.com/v1) и API-ключ этого провайдера.
    • CLI попытается проверить модель через <baseUrl>/models, но сохранит запись, даже если эндпоинт недоступен или провайдер не отдает этот список.
    • Сохраненные модели лежат в ~/.config/koda/credentials.json.

  • Отредактировать или удалить кастомную модель:

    • Выберите кастомную модель в списке (они помечены как {model} (custom)).
    • Нажмите E, чтобы отредактировать модель, и D, чтобы удалить ее. Если удаленная модель была активной, CLI автоматически переключится на доступную встроенную модель.
    • В окне редактирования используйте Enter для перехода/сохранения, Tab для смены поля, Esc для отмены.

  • /about

  • Описание: Показать информацию о версии. Пожалуйста, поделитесь этой информацией при подаче проблем.

  • /tools

  • Описание: Отобразить список инструментов, которые в настоящее время доступны в Koda CLI.

  • Подкоманды:

    • desc или descriptions:
    • Описание: Показать подробные описания каждого инструмента, включая название инструмента с его полным описанием, предоставляемым модели.
    • nodesc или nodescriptions:
    • Описание: Скрыть описания инструментов, показывая только их названия.

  • /quit (или /exit)

  • Описание: Выйти из Koda CLI.

  • /vim

  • Описание: Переключить режим vim вкл. или выкл. Когда режим vim включен, область ввода поддерживает навигацию и команды редактирования в стиле vim в режимах NORMAL и INSERT.
  • Функции:
    • NORMAL режим: Навигация с помощью h, j, k, l; переход по словам с w, b, e; переход к началу/концу строки с 0, $, ^; переход к определенным строкам с G (или gg для первой строки)
    • INSERT режим: Обычный ввод текста с возможностью выхода в NORMAL режим
    • Команды редактирования: Удаление с x, изменение с c, вставка с i, a, o, O; сложные операции как dd, cc, dw, cw
    • Поддержка подсчета: Применение команд с цифрами (например, 3h, 5w, 10G)
    • Повтор последней команды: Используйте ., чтобы повторить последнюю операцию редактирования

  • Индикатор статуса: При включении показывает [NORMAL] или [INSERT] в нижнем колонтитуле

  • /init

  • Описание: Чтобы помочь пользователям легко создать файл KODA.md, эта команда анализирует текущий каталог и генерирует настроенный файл контекста, облегчая им предоставление инструкций, специфичных для проекта, агенту Koda.

Команды с @ (@)

Команды с @ используются для включения содержимого файлов или каталогов как части вашей подсказки для Koda. Эти команды включают фильтрацию с учетом git.

  • @<путь_к_файлу_или_каталогу>
  • Описание: Вставьте содержимое указанного файла или файлов в ваш текущий запрос. Это полезно для задания вопросов о конкретном коде, тексте или коллекциях файлов.
  • Примеры:
    • @path/to/your/file.txt Объясните этот текст.
    • @src/my_project/ Резюмируйте код в этом каталоге.
    • Что это за файл? @README.md
  • Подробности:
    • Если указан путь к одному файлу, читается содержимое этого файла.
    • Если указан путь к каталогу, команда пытается прочитать содержимое файлов в этом каталоге и любых подкаталогах.
    • Пробелы в путях должны быть экранированы обратной косой чертой (например, @My\ Documents/file.txt).
    • Команда использует инструмент read_many_files внутри. Содержимое загружается, а затем вставляется в ваш запрос перед отправкой модели Koda.
    • Фильтрация с учетом git: По умолчанию исключаются файлы, игнорируемые git (например, node_modules/, dist/, .env, .git/). Это поведение можно изменить с помощью настроек fileFiltering.
    • Типы файлов: Команда предназначена для файлов на основе текста. Хотя она может попытаться прочитать любой файл, двоичные файлы или очень большие файлы могут быть пропущены или усечены внутренним инструментом read_many_files, чтобы обеспечить производительность и актуальность. Инструмент указывает, были ли файлы пропущены.

  • Вывод: CLI покажет сообщение вызова инструмента, указывающее, что был использован read_many_files, а также сообщение с деталями статуса и обработанными путями.

  • @ (Одинокий символ @)

  • Описание: Если вы наберете одинокий символ @ без пути, запрос передается как есть модели Koda. Это может быть полезно, если вы конкретно говорите о символе @ в вашем запросе.

Обработка ошибок для команд @

  • Если путь, указанный после @, не найден или недействителен, будет отображено сообщение об ошибке, и запрос может не быть отправлен модели Koda, или будет отправлен без содержимого файла.
  • Если инструмент read_many_files сталкивается с ошибкой (например, проблемы с разрешениями), это также будет сообщено.

Режим оболочки и сквозные команды (!)

Префикс ! позволяет взаимодействовать с оболочкой вашей системы напрямую из CLI Koda.

  • !<команда_оболочки>
  • Описание: Выполнить заданную <команду_оболочки> с помощью bash на Linux/macOS или cmd.exe на Windows. Любой вывод или ошибки команды отображаются в терминале.

  • Примеры:

    • !ls -la (выполняет ls -la и возвращается в Koda CLI)
    • !git status (выполняет git status и возвращается в Koda CLI)

  • ! (Переключение режима оболочки)

  • Описание: Ввод ! сам по себе переключает режим оболочки.

    • Вход в режим оболочки:
    • В активном состоянии режим оболочки использует другую раскраску и индикатор режима оболочки.
    • В режиме оболочки текст, который вы вводите, интерпретируется напрямую как команда оболочки.
    • Выход из режима оболочки:
    • При выходе интерфейс возвращается к стандартному внешнему виду, и возобновляется нормальное поведение Koda CLI.

  • Внимание при использовании всех !: Команды, которые вы выполняете в режиме оболочки, имеют те же разрешения и влияние, что и при их прямом запуске в вашем терминале.