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

Компаньон для IDE

Koda CLI может получать контекст из редактора через Koda CLI Companion. Companion — это отдельное расширение для IDE. Оно передаёт CLI сведения об открытом проекте, активном файле, курсоре, выделенном тексте и позволяет открывать diff прямо в редакторе.

Интеграция работает только когда koda запущен из терминала внутри той же IDE, где установлен компаньон.

Что нужно установить

Вам нужны две части:

Часть Где устанавливается
Koda CLI в системе через npm
Koda CLI Companion в IDE как плагин

Страница загрузки компаньона: cli-companion.kodacode.ru/

Внутри CLI можно открыть эту страницу командой:

/ide install

Команда /ide install открывает страницу загрузки, но не устанавливает компаньона автоматически.

Поддерживаемые IDE

  • VS Code 1.99 или новее.
  • Cursor и другие редакторы, совместимые с расширениями VS Code.
  • JetBrains IDE 2023.3 или новее: IntelliJ IDEA, WebStorm, PyCharm, PhpStorm и другие.

Установка в VS Code и Cursor

  1. Откройте проект в VS Code или Cursor.
  2. Установите Koda CLI Companion:
  3. либо через страницу cli-companion.kodacode.ru/;
  4. либо через расширения, если расширение доступно в вашем каталоге расширений;
  5. либо через команду Extensions: Install from VSIX..., если вы скачали .vsix файл.
  6. Перезагрузите окно IDE, если редактор попросит это сделать.
  7. Откройте новый встроенный терминал: Terminal -> New Terminal.
  8. Убедитесь, что терминал открыт в корне того же проекта.
  9. Запустите CLI:
koda
  1. Внутри Koda CLI включите интеграцию:
/ide enable
  1. Проверьте подключение:
/ide status

Если всё настроено правильно, статус будет Connected, а ниже появится список открытых файлов, которые CLI получает из IDE.

Установка в JetBrains IDE

  1. Откройте IntelliJ IDEA, WebStorm, PyCharm или другую JetBrains IDE версии 2023.3 или новее.
  2. Скачайте плагин-компаньон со страницы cli-companion.kodacode.ru/.
  3. Установите плагин из файла:
  4. File | Settings | Plugins;
  5. кнопка с шестеренкой;
  6. Install Plugin from Disk...;
  7. выберите скачанный архив плагин.
  8. Перезапустите IDE, если она попросит.
  9. Откройте проект.
  10. Откройте встроенный терминал: View | Tool Windows | Terminal.
  11. Перейдите в корень открытого проекта и запустите:
koda
  1. Внутри Koda CLI включите интеграцию:
/ide enable
  1. Проверьте подключение:
/ide status

Компаньон передаёт контекст рабочей области и поддерживает diff-сценарии. Часть diff-сценариев может отличаться от VS Code, потому что Компаньон развивается отдельно.

Зачем нужен встроенный терминал

Companion передаёт CLI служебные переменные окружения с адресом IDE-сервера и путями рабочей области. Эти переменные попадают в новые терминалы, открытые внутри IDE.

Если запустить koda из обычного системного терминала, CLI часто не увидит компаньона, даже если плагин установлен.

Правильный порядок:

  1. Открыть проект в IDE.
  2. Убедиться, что компаньон установлен и включён.
  3. Открыть новый терминал внутри IDE.
  4. Запустить koda из этого терминала.
  5. Выполнить /ide enable.

Если терминал был открыт до установки компаньона, закройте его и откройте новый.

Команды IDE-интеграции

Команды регистрируются только при запуске CLI из терминала IDE. Перечень команд — в справочнике команд.

Команда Что делает
/ide install открывает страницу загрузки компаньона
/ide enable включает IDE mode в настройках пользователя и пытается подключиться
/ide status показывает состояние подключения, IDE и открытые файлы
/ide disable выключает IDE mode

Что получает CLI

Когда интеграция подключена, Koda CLI может учитывать:

  • список недавно открытых файлов;
  • активный файл;
  • позицию курсора;
  • выделенный текст;
  • корень рабочей области;
  • diff, открытый в IDE при изменении файлов.

CLI не получает весь проект только из-за включения IDE-интеграции. Файлы добавляются в контекст по запросу, через инструменты, @-ссылки, память проекта и обычные механизмы CLI.

Работа с diff

Когда агент предлагает изменение файла, CLI может открыть diff в IDE. В diff можно:

  • просмотреть изменения;
  • отредактировать предложенный результат;
  • принять diff;
  • закрыть diff и отклонить изменение.

В VS Code доступны команды:

  • Koda CLI: Run;
  • Koda CLI: Accept Diff;
  • Koda CLI: Close Diff Editor;
  • Koda CLI: View Third-Party Notices.

В JetBrains IDE похожие действия доступны через Find Action и команды Koda CLI.

Если не подключается

Симптом Что сделать
/ide status показывает disconnected Откройте новый встроенный терминал IDE и запустите koda заново
CLI пишет, что IDE не поддерживается Проверьте, что koda запущен из терминала поддерживаемой IDE
Нет открытых файлов в статусе Откройте локальный файл в IDE и повторите /ide status
Несовпадение рабочей области Запустите CLI из корня того проекта, который открыт в IDE
Diff не появляется Обновите компаньона, перезапустите IDE и снова выполните /ide enable