Файл config.yaml¶

Koda использует файл конфигурации config.yaml для настройки моделей, контекстных провайдеров и других параметров.

Для переопределения параметров в отдельном проекте используйте файл .kodarc.json.

Расположение файла конфигурации:

• Windows: %USERPROFILE%/.koda/config.yaml
• Linux / MacOS: $HOME/.koda/config.yaml

Базовая структура¶

name: Koda
version: 0.0.1
schema: v1

models:
  - name: Koda Models
    provider: koda-chat-models
    model: AUTODETECT
    roles: [agent, chat, edit]

context:
  - provider: code
  - provider: docs
  - provider: diff
  - provider: terminal
  - provider: problems
  - provider: folder
  - provider: codebase

Файл .kodarc.json¶

Помимо глобального config.yaml, Koda читает файл .kodarc.json в корне каждого проекта рабочей области. Он позволяет переопределить часть параметров конфигурации для конкретного проекта, не затрагивая глобальные настройки других проектов.

Структура¶

Файл имеет формат JSON и использует те же свойства, что и config.yaml. Достаточно перечислить только те свойства, которые вы хотите переопределить для проекта.

{
  "models": [
    {
      "name": "Koda Models",
      "provider": "koda-chat-models",
      "model": "AUTODETECT",
      "roles": ["agent", "chat", "edit"]
    }
  ],
  "context": [
    { "provider": "code" },
    { "provider": "diff" },
    { "provider": "codebase" }
  ],
  "rules": ["Always use TypeScript"],
  "mergeBehavior": "merge"
}

Полный пример с промптами и MCP-серверами:

{
  "context": [
    { "provider": "codebase", "params": { "nFinal": 10 } },
    { "provider": "diff", "params": { "includeUnstaged": false } }
  ],
  "rules": [
    {
      "name": "Code style",
      "rule": "Use strict type annotations"
    }
  ],
  "prompts": [
    {
      "name": "check",
      "description": "Check for mistakes in my code",
      "prompt": "Please read the highlighted code and check for any mistakes"
    }
  ],
  "mcpServers": [
    {
      "name": "Filesystem",
      "command": "npx",
      "args": ["-y", "@modelcontextprotocol/server-filesystem", "/Users/NAME/Documents"]
    }
  ],
  "mergeBehavior": "merge"
}

Состав свойств и их параметры идентичны config.yaml:

Объединение с глобальным конфигом¶

Способ объединения с глобальным конфигом задаётся свойством mergeBehavior:

Спецификация¶

models¶

Определяет языковые модели для разных режимов Koda.

Koda поддерживает различные роли для моделей:

• chat — для обычного чата
• edit — для редактирования кода
• agent — для агентского режима
• plan — для режима планирования
• autocomplete — для автодополнения кода
• apply — для применения изменений кода
• embed — для создания эмбеддингов
• rerank — для ранжирования результатов

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

defaultCompletionOptions¶

requestOptions¶

clientCertificate¶

embedOptions¶

chatOptions¶

promptTemplates¶

context¶

Провайдеры контекста, которые можно добавить к сообщению через @.

provider¶

Значение provider выбирает встроенный провайдер контекста. Провайдер появляется в меню @ поля ввода, только если он перечислен в секции context. Исключение — провайдеры file и codebase: они доступны всегда, даже если их нет в списке.

Провайдеры различаются способом выбора данных:

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

file¶

Добавляет содержимое выбранного файла целиком. В подменю перечислены файлы рабочей области, кроме исключённых через .gitignore и .kodaignore, а недавно открытые файлы показаны первыми. Если файл не помещается в окно контекста выбранной модели, Koda покажет предупреждение и не добавит его.

Провайдер доступен всегда и не требует настройки.

codebase¶

Ищет в индексе кодовой базы фрагменты кода, релевантные тексту сообщения, и добавляет найденное. Запросом служит всё сообщение целиком, поэтому формулируйте его конкретно. Поиск сочетает полнотекстовый поиск по индексу, поиск по смыслу (если доступна модель с ролью embed) и недавно изменённые файлы.

Провайдер доступен всегда. Без индекса он находит только фрагменты недавно изменённых файлов, поэтому включите индексацию.

context:
  - provider: codebase
    params:
      nFinal: 10

code¶

Добавляет код выбранной функции, класса или метода. Подменю строится по индексу кодовой базы, поэтому без индексации оно пустое. Список также пуст, если в disabledIndexes указан индекс snippets.

В JetBrains провайдер не показывается в меню @.

folder¶

Ищет фрагменты кода, релевантные сообщению, только в выбранной папке. Провайдер работает так же, как codebase, но с ограничением по папке: в запрос попадают не все файлы папки, а только найденные фрагменты. В подменю перечислены папки рабочей области.

diff¶

Добавляет текущие изменения git по всем репозиториям рабочей области. Новые файлы, ещё не добавленные в git, в результат не попадают. Если изменений нет, модель получит сообщение об их отсутствии.

Состав изменений зависит от IDE:

context:
  - provider: diff
    params:
      includeUnstaged: false

terminal¶

Добавляет последнюю выполненную в терминале команду и её вывод. В VS Code используется активный терминал, в JetBrains — выбранная вкладка встроенного терминала. Если открытых терминалов нет, контекст будет пустым.

problems¶

Добавляет диагностику активного файла: текст каждой проблемы и фрагмент кода вокруг неё. В VS Code учитываются все сообщения панели Problems, в JetBrains — только ошибки и предупреждения. Если проблем нет, модель получит сообщение об их отсутствии.

currentFile¶

Добавляет содержимое файла, активного в редакторе. Без настройки тот же файл можно приложить, отправив сообщение сочетанием Alt + Enter.

open¶

Добавляет содержимое всех открытых в редакторе файлов.

context:
  - provider: open
    params:
      onlyPinned: true

tree¶

Добавляет дерево файлов и папок всех проектов рабочей области. Файлы, исключённые через .gitignore и .kodaignore, не показываются. В больших проектах дерево может занять значительную часть контекста.

repo-map¶

Добавляет карту проекта: список файлов и сигнатуры классов, функций и методов в них. В подменю можно выбрать весь проект (Entire codebase) или отдельную папку. Объём карты ограничен половиной окна контекста модели.

context:
  - provider: repo-map
    params:
      includeSignatures: false

search¶

Ищет текст по файлам проекта с помощью ripgrep и добавляет найденные строки с номерами. После выбора провайдера введите запрос — это регулярное выражение, регистр букв не учитывается. В результат попадает не больше 200 совпадений на файл, длинные строки обрезаются.

url¶

Загружает веб-страницу и добавляет её основной текст в формате Markdown. После выбора провайдера введите адрес страницы целиком, включая https://. JavaScript на странице не выполняется, поэтому содержимое, которое строится в браузере, не попадёт в контекст. Если страница не загрузилась за 60 секунд или не содержит текста, ничего не добавляется.

os¶

Добавляет название операционной системы и архитектуру процессора. Полезно для вопросов об установке, путях и командах оболочки.

clipboard¶

Добавляет один из последних 10 фрагментов, скопированных в редакторе VS Code. Копирование из других приложений не учитывается, а список очищается при перезапуске IDE.

debugger¶

Добавляет локальные переменные и исходный код верхних кадров стека вызовов. Работает только в VS Code во время сеанса отладки, остановленного на точке останова. В подменю перечислены приостановленные потоки.

context:
  - provider: debugger
    params:
      stackDepth: 5

commit¶

Добавляет коммит git вместе с изменениями. В подменю перечислены последние коммиты первого проекта рабочей области, а первым пунктом идёт last N commits — сразу несколько последних коммитов. Для работы нужен установленный git.

context:
  - provider: commit
    params:
      Depth: 100
      LastXCommitsDepth: 20

http¶

Получает контекст от вашего HTTP-сервера. При отправке сообщения Koda делает запрос POST на указанный адрес и передаёт в теле JSON с полями:

• query — строка запроса провайдера (обычно пустая);
• fullInput — полный текст сообщения;
• options — значение параметра options.

Сервер должен вернуть JSON-объект или массив объектов с полями name, description и content. В запрос к модели попадает значение content.

context:
  - provider: http
    name: Внутренняя вики
    params:
      title: wiki
      url: https://wiki.example.com/koda-context
      headers:
        Authorization: Bearer <токен>
      options:
        space: backend

google¶

Ищет в Google и добавляет заголовки, адреса и краткие описания найденных страниц. После выбора провайдера введите поисковый запрос. Для работы нужен ключ сервиса Serper.

context:
  - provider: google
    params:
      serperApiKey: <ключ>

issue¶

Добавляет задачу GitHub: описание и все комментарии. В подменю перечислены задачи из указанных репозиториев.

Поля элемента repos:

context:
  - provider: issue
    params:
      githubToken: <токен>
      repos:
        - owner: myorg
          repo: myrepo
          type: open

gitlab-mr¶

Находит открытые merge request для текущей ветки и добавляет их название, описание и комментарии к строкам кода. Для каждого комментария указываются автор, дата, статус обсуждения и строка, к которой он оставлен. Провайдер работает с первым проектом рабочей области: у текущей ветки должна быть настроена ветка на удалённом сервере.

context:
  - provider: gitlab-mr
    params:
      domain: gitlab.company.com
      token: <токен>
      filterComments: true

jira¶

Добавляет задачу Jira: заголовок, описание и комментарии. В подменю перечислены задачи, найденные по JQL-запросу. Провайдер работает с Jira Server и Jira Data Center.

context:
  - provider: jira
    params:
      domain: jira.company.com
      token: <токен>
      apiVersion: "2"
      maxResults: 30

postgres¶

Добавляет структуру таблицы PostgreSQL (столбцы и их типы) и несколько её строк. В подменю перечислены таблицы выбранной схемы и пункт All tables для всех таблиц сразу.

context:
  - provider: postgres
    params:
      host: localhost
      port: 5432
      user: developer
      password: <пароль>
      database: myapp
      schema: public
      sampleRows: 5

database¶

Добавляет структуру таблиц одной или нескольких баз данных без самих данных. В подменю для каждого подключения перечислены его таблицы и пункт со структурой всех таблиц сразу.

Поля элемента connections:

Параметры connection зависят от типа СУБД:

Для PostgreSQL учитываются только таблицы схемы public.

context:
  - provider: database
    params:
      connections:
        - name: local
          connection_type: sqlite
          connection:
            filename: /path/to/db.sqlite
        - name: main
          connection_type: postgres
          connection:
            host: localhost
            port: 5432
            user: developer
            password: <пароль>
            database: myapp

discord¶

Добавляет последние сообщения из выбранного текстового канала Discord. В подменю перечислены текстовые каналы сервера.

Бот должен быть добавлен на сервер с правом читать историю сообщений. Чтобы получать текст сообщений, включите для бота Message Content Intent в настройках приложения Discord.

context:
  - provider: discord
    params:
      discordKey: <токен бота>
      guildId: "1234567890"

rules¶

Правила, объединяемые в системное сообщение для всех режимов.

rules:
  - Always use TypeScript
  - Write Google-style docstrings
  - name: Server-side components
    rule: Use Next.js server components where possible
    if: ${{ glob("*.tsx") and contains(current.model.model, "claude-3-7-sonnet") }}

Условные правила могут применяться с помощью выражений в синтаксисе if.

Доступные функции для if:

Доступные переменные для if:

rules:
  - name: TypeScript Strict
    rule: Use strict type annotations
    if: ${{ glob("*.ts") or glob("*.tsx") }}

rules:
  - name: Detailed Explanations
    rule: Provide detailed explanations with code examples
    if: ${{ contains(current.model.model, "gpt-4") }}

rules:
  - name: React Best Practices
    rule: Use functional components with hooks
    if: ${{ glob("*.tsx") and contains(current.model.model, "claude-3-7-sonnet") }}

rules:
  - name: Python Type Hints
    rule: Add type hints to all function signatures
    if: ${{ glob("*.py") and not glob("*_test.py") }}

prompts¶

Пользовательские промпты, вызываемые из окна чата.

prompts:
  - name: check
    description: Check for mistakes in my code
    prompt: |
      Please read the highlighted code and check for any mistakes:
        - Syntax errors
        - Logic errors
        - Security vulnerabilities
  - name: test
    description: Write unit tests
    prompt: Write comprehensive unit tests for the selected code using Jest

Внутри prompt доступны контекст-провайдеры (упоминаются в тексте через @) и встроенные переменные:

mcpServers¶

Model Context Protocol серверы.

mcpServers:
  - name: SQLite
    command: uvx
    args:
      - "mcp-server-sqlite"
      - "--db-path"
      - "/Users/NAME/test.db"
  - name: Filesystem
    command: npx
    args:
      - "-y"
      - "@modelcontextprotocol/server-filesystem"
      - "/Users/NAME/Documents"

indexingOptions¶

Тонкая настройка индексации кодовой базы: производительность и объём потребляемых ресурсов. По умолчанию индексация выключена; включить её можно в настройках плагина или параметром disableIndexing.

indexingOptions:
  concurrency: 4
  batchSize: 100
  disabledIndexes:
    - fts

disableIndexing¶

true

Отключает индексацию кодовой базы. Чтобы включить индексацию, укажите disableIndexing: false или включите переключатель Включить индексацию в настройках плагина. Значение, выбранное в настройках плагина, имеет приоритет над файлом конфигурации.

Без индекса провайдеры codebase и folder находят только фрагменты недавно изменённых файлов, подменю code остаётся пустым, а repo-map добавляет список файлов без сигнатур. Остальные провайдеры контекста работают как обычно.