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

Аргументы CLI

Команда запуска называется koda. Справочник описывает флаги запуска, значения по умолчанию и связанные переменные окружения. Общие настройки и их приоритет — на странице настройки, команды внутри сессии — в справочнике команд.

Приоритет настроек

От низшего к высшему:

  1. Значения по умолчанию — встроены в код;
  2. settings.json — файлы настроек;
  3. Переменные окружения — переопределяют настройки (если заданы);
  4. CLI-флаги — переопределяют переменные окружения и настройки (если заданы явно).

Основной запуск

Команда Назначение
koda открыть интерактивную сессию
koda -p "prompt" выполнить prompt в неинтерактивном режиме и выйти
koda -i "prompt" выполнить prompt и продолжить интерактивно
koda --version показать версию (алиас -v)
koda --help показать справку (алиас -h)

Глобальные флаги --help/-h и --version/-v предоставляются самим парсером аргументов и доступны для koda и всех подкоманд.

Опции

Опция Алиас Назначение
--model <id> -m выбрать модель
--prompt <text> -p prompt для неинтерактивного режима; stdin добавляется к prompt
--prompt-interactive <text> -i выполнить prompt и оставить TUI открытым
--sandbox -s запустить CLI в песочнице
--sandbox-image <uri> образ для Docker/Podman sandbox
--debug -d включить debug-режим
--all-files -a включить все найденные файлы в контекст
--show-memory-usage показывать использование памяти в статусной строке
--show-reasoning выводить reasoning модели в stderr в неинтерактивном режиме
--output-format <format> формат вывода: text, json или stream-json
--input-format <format> формат ввода: text или stream-json
--show-usage отчёт об использовании в stderr в текстовом режиме
--max-turns <n> лимит витков агента в неинтерактивном режиме
--allowed-tools <names...> оставить только перечисленные встроенные инструменты
--disallowed-tools <names...> исключить перечисленные инструменты
--append-system-prompt <text> дописать текст в конец системного промпта
--approval-mode <mode> default, auto_edit или yolo
--yolo -y алиас для --approval-mode=yolo
--checkpointing -c включить checkpointing изменений файлов
--acp --experimental-acp запустить агент в ACP-режиме для IDE-клиента
--allowed-mcp-server-names <names...> ограничить набор MCP-серверов
--extensions <names...> -e включить только указанные расширения; значение none отключает все
--list-extensions -l вывести доступные расширения и выйти
--proxy <url> proxy для Koda client
--ca-file <path> путь к PEM-набору корневых сертификатов
--include-directories <dirs...> добавить каталоги в рабочую область; можно передавать через запятую
--telemetry включить отправку телеметрии
--telemetry-target <target> цель телеметрии: local или gcp
--telemetry-otlp-endpoint <url> OTLP-адрес для телеметрии
--telemetry-log-prompts включить или отключить логирование промптов
--telemetry-outfile <path> перенаправить вывод телеметрии в файл

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


Модель и контекст

--model

v0.1.6 koda-base KODA_MODEL

Модель для диалога. Значение по умолчанию применяется, если модель не задана настройками или переменными окружения.


--all-files

v0.1.10 false

Включить все найденные файлы в контекст.


--include-directories

v0.1.16

Добавить каталоги в рабочую область. Каталоги можно передавать через запятую или повторяя флаг.

Работает вместе с настройками

CLI-флаги добавляются к значению настройки includeDirectories, а не заменяют его.


Режим запуска

--prompt

v0.1.6

Prompt для неинтерактивного режима. Содержимое stdin добавляется к prompt.

Нельзя использовать вместе с --prompt-interactive


--prompt-interactive

v0.1.12

Выполнить prompt и продолжить в интерактивном режиме.

Нельзя использовать вместе с --prompt


--show-reasoning

v1.1.1 false

В неинтерактивном режиме выводить reasoning модели в stderr. В stdout остаётся только ответ.


Неинтерактивный режим

Флаги этой секции действуют, когда CLI работает без интерфейса: с --prompt, с вводом из stdin или с --input-format stream-json. Подробное описание режима, форматов и кодов завершения — на странице headless-режим.

--output-format

v1.3.0 text

Формат вывода неинтерактивного прогона:

  • text — только ответ модели в stdout;
  • json — один JSON-объект с результатом, метриками и отчётом об использовании;
  • stream-json — поток событий NDJSON: одно событие в строке.

Структура объектов

Поля result, события потока и отчёт usage описаны в разделе вывод.


--input-format

v1.3.0 text

Формат ввода неинтерактивного прогона:

  • text — весь stdin и --prompt как один запрос;
  • stream-json — построчный поток сообщений пользователя для многовиткового диалога в одном процессе.

Флаг --input-format stream-json включает неинтерактивный режим, даже когда stdin подключён к терминалу.

Нельзя использовать вместе с --prompt и --prompt-interactive

В режиме stream-json сообщения приходят только из stdin.


--show-usage

v1.3.0 false

В текстовом режиме печатать отчёт об использовании в stderr после завершения прогона: витки, длительность, токены и вызовы инструментов. В режимах json и stream-json отчёт всегда входит в поле usage, и флаг не нужен.


--max-turns

v1.3.0

Лимит витков агента в неинтерактивном режиме. Принимает целое число не меньше 1.

Перекрывает настройку maxSessionTurns. Упор в лимит даёт код выхода 2 и stop_reason: "limit".


--allowed-tools

v1.3.0

Оставить модели только перечисленные встроенные инструменты. Действует как настройка coreTools, но на один запуск.

Список можно передавать через запятую или повторяя флаг.


--disallowed-tools

v1.3.0

Исключить перечисленные инструменты. Применяется поверх --allowed-tools и пользовательских исключений.

Список можно передавать через запятую или повторяя флаг.


--append-system-prompt

v1.3.0

Дописать текст в конец системного промпта после памяти проекта из KODA.md. Файлы проекта при этом не меняются.


Подтверждение действий

--approval-mode

v0.1.20

Режим подтверждения вызова инструментов:

  • default — запрашивать подтверждение;
  • auto_edit — автоматически подтверждать инструменты редактирования;
  • yolo — автоматически подтверждать все инструменты.

Нельзя использовать вместе с --yolo

Используйте --approval-mode=yolo вместо комбинации флагов.


--yolo

v0.1.6 false

Алиас для --approval-mode=yolo.


Песочница

Подробнее — на странице о песочнице.

--sandbox

v0.1.6 false KODA_SANDBOX

Запустить CLI в песочнице. Значением может быть true, false или одна из команд: docker, podman, sandbox-exec.

!!! info "Переменная окружения" KODA_SANDBOX имеет приоритет над флагом и настройками.


--sandbox-image

v0.1.6 KODA_SANDBOX_IMAGE

Образ для Docker/Podman sandbox. По умолчанию используется образ, заданный в конфигурации пакета.


Отладка и мониторинг

--debug

v0.1.6 false DEBUG, DEBUG_MODE

Включить debug-режим.

Переменные окружения

DEBUG или DEBUG_MODE со значением true или 1 включают debug-режим без флага.


--show-memory-usage

v0.1.10 false

Показывать использование памяти в статусной строке.


Сеть

--proxy

v0.1.13 HTTPS_PROXY, HTTP_PROXY

Строка подключения к прокси-серверу в формате schema://user:password@host:port. Имеет приоритет над переменными окружения и настройками.


--ca-file

v1.1.1

Путь к PEM-набору корневых сертификатов для HTTP-запросов CLI. Имеет приоритет над настройкой network.caFile.


Checkpointing

--checkpointing

v0.1.6 false

Включить checkpointing изменений файлов. Эквивалентен настройке checkpointing.enabled.

Подробнее — на странице контрольные точки.


MCP и расширения

--allowed-mcp-server-names

v0.1.10

Ограничить набор MCP-серверов, которые могут использоваться. Переопределяет настройки allowMCPServers и excludeMCPServers.

Настройка серверов описана в разделе MCP-серверы.


--extensions

v0.1.10

Включить только указанные расширения. Значение none отключает все расширения.


--list-extensions

v0.1.10 false

Вывести доступные расширения и выйти.


Телеметрия

--telemetry

v0.1.6

Включить отправку телеметрии. Другие флаги --telemetry-* задают отдельные значения, но сами по себе телеметрию не включают.


--telemetry-target

v0.1.6

Цель телеметрии: local или gcp. Переопределяет настройки.


--telemetry-otlp-endpoint

v0.1.6 OTEL_EXPORTER_OTLP_ENDPOINT

OTLP-адрес для телеметрии. Переопределяет переменную окружения и настройки.


--telemetry-log-prompts

v0.1.6

Включить или отключить логирование пользовательских промптов для телеметрии. Переопределяет настройки.


--telemetry-outfile

v0.1.14

Перенаправить весь вывод телеметрии в указанный файл.


IDE-интеграция

--acp

v1.1.1

Запустить агент в ACP-режиме для IDE-клиента, например JetBrains AI Assistant. Алиас: --experimental-acp.

Подробнее — на странице ACP-режим.


Подкоманды верхнего уровня

Помимо основного запуска koda поддерживает встроенные подкоманды для управления MCP-серверами, языком интерфейса, расширениями, навыками и интеграциями с терминалами. Все подкоманды выполняются однократно, выводят результат в терминал и завершают процесс, не открывая сессию.

Общий синтаксис:

koda <подкоманда> <действие> [аргументы] [опции]

Неизвестные опции и подкоманды приводят к ошибке разбора: CLI работает в строгом режиме.


MCP

v1.1.1

Подкоманда koda mcp управляет MCP-серверами: добавляет, удаляет и показывает настроенные серверы.

koda mcp <add|remove|list> [аргументы] [опции]

Без указания действия koda mcp показывает справку.

koda mcp add

Добавляет или обновляет MCP-сервер в настройках.

koda mcp add [options] <name> <commandOrUrl> [args...]

Позиционные аргументы:

Аргумент Обязательный Назначение
name да имя сервера, под которым он будет сохранён в настройках
commandOrUrl да команда запуска (stdio) или URL сервера (sse, http)
args нет аргументы команды запуска для транспорта stdio

Опции:

Опция Алиас Значения По умолчанию Назначение
--scope -s user, project project область настроек: user — глобально, project — для проекта
--transport -t stdio, sse, http stdio тип транспорта сервера
--env -e KEY=value (можно повторять) переменные окружения для процесса сервера (только stdio)
--header -H Header: value (можно повторять) HTTP-заголовки для серверов sse и http
--timeout число (миллисекунды) 10 минут таймаут подключения и вызовов инструментов
--trust true / false false доверять серверу: пропускать подтверждения вызовов инструментов
--description строка описание сервера
--include-tools список имён через запятую (можно повторять) разрешить только перечисленные инструменты
--exclude-tools список имён через запятую (можно повторять) скрыть перечисленные инструменты от модели

Если сервер с таким именем уже существует, команда обновляет его конфигурацию.

Примеры:

koda mcp add my-server npx @some/mcp-server
koda mcp add remote --transport sse --header "X-Api-Key: abc123" https://example.com/sse
koda mcp add gated --transport http --include-tools list,read --trust https://example.com/mcp

Аргументы с дефисом

Аргументы запуска, начинающиеся с дефиса (-y, --rm), команда может принять за свои опции или завершиться ошибкой неизвестного аргумента. Если серверу нужны такие аргументы, добавьте его через settings.json — см. примеры подключения.


koda mcp remove

Удаляет MCP-сервер из настроек.

koda mcp remove [options] <name>

Позиционные аргументы:

Аргумент Обязательный Назначение
name да имя удаляемого сервера

Опции:

Опция Алиас Значения По умолчанию Назначение
--scope -s user, project project область настроек, из которой удалить

Если сервер не найден в выбранной области, команда сообщает об этом и завершается без изменений.


koda mcp list

Показывает настроенные MCP-серверы и их статус подключения.

koda mcp list

Команда не принимает аргументов. Для каждого сервера выводится имя, команда или URL, тип транспорта и статус после попытки реального подключения:

  • ✓ Connected — сервер ответил на ping;
  • ✗ Disconnected — подключиться не удалось;
  • … Connecting — подключение ещё выполняется.

Language

v1.1.1

Подкоманда koda language управляет языком интерфейса.

koda language <set> <language>

koda language set

Устанавливает язык интерфейса в пользовательских настройках.

koda language set <language>

Позиционные аргументы:

Аргумент Обязательный Значения Назначение
language да en, ru код языка интерфейса

Примеры:

koda language set ru
koda language set en

После изменения перезапустите другие запущенные экземпляры koda, чтобы язык применился.


Extensions

v1.1.1

Подкоманда koda extensions управляет расширениями.

koda extensions <install|uninstall|list|update|enable|disable> [аргументы] [опции]

koda extensions install

Устанавливает расширение из git-репозитория или локальной директории.

koda extensions install [options] [source]

Позиционные аргументы:

Аргумент Обязательный Назначение
source нет git-URL расширения

Опции:

Опция Значения Назначение
--path строка путь к локальной директории расширения

Аргументы source и --path взаимоисключающие: должен быть указан ровно один из них. После установки расширение включается автоматически.

Примеры:

koda extensions install https://github.com/example/my-extension
koda extensions install --path ./local-extension

koda extensions uninstall

Удаляет установленное расширение.

koda extensions uninstall <name>

Позиционные аргументы:

Аргумент Обязательный Назначение
name да имя удаляемого расширения

koda extensions list

Показывает установленные расширения.

koda extensions list

Команда не принимает аргументов. Если расширений нет, выводится No extensions installed.


koda extensions update

Обновляет расширение до последней версии.

koda extensions update <name>

Позиционные аргументы:

Аргумент Обязательный Назначение
name да имя обновляемого расширения

При успехе выводится сообщение о смене версии: старая → новая.


koda extensions enable

Включает расширение в указанной области настроек.

koda extensions enable [options] <name>

Позиционные аргументы:

Аргумент Обязательный Назначение
name да имя включаемого расширения

Опции:

Опция Значения По умолчанию Назначение
--scope User, Workspace область включения; без опции — во всех областях

koda extensions disable

Отключает расширение в указанной области настроек.

koda extensions disable [options] <name>

Позиционные аргументы:

Аргумент Обязательный Назначение
name да имя отключаемого расширения

Опции:

Опция Значения По умолчанию Назначение
--scope User, Workspace User область, в которой отключить

Skills

v1.1.1

Подкоманда koda skills управляет навыками агента: установкой, удалением и состоянием включения.

koda skills <list|install|uninstall|enable|disable> [аргументы] [опции]

Область настроек (--scope) во всех подкомандах принимает user, project или workspace. Области project и workspace эквивалентны: обе соответствуют настройкам рабочего каталога.

koda skills list

Показывает обнаруженные навыки.

koda skills list

Команда не принимает аргументов. Для каждого навыка выводятся имя, описание и метки: disabled — отключён, builtin — встроенный.


koda skills install

Устанавливает навыки из git-репозитория, локальной директории или .skill-пакета.

koda skills install [options] [source]

Позиционные аргументы:

Аргумент Обязательный Назначение
source нет git-URL, путь к локальной директории навыка или .skill-пакет

Опции:

Опция Алиас Значения По умолчанию Назначение
--path строка локальная директория, если source не указан, или поддиректория внутри source
--scope -s user, project, workspace user область установки

Источником служит source либо --path. Если source указывает на репозиторий, а --path задан, устанавливается навык из указанной поддиректории репозитория. Установка копирует каталог навыка в ~/.kodacli/skills (область user) или <проект>/.kodacli/skills (область project).

Примеры:

koda skills install https://github.com/example/my-skills
koda skills install --path ./my-skill
koda skills install https://github.com/example/mono-repo --path packages/skill-a --scope project
koda skills install ./skill-package.skill

koda skills uninstall

Удаляет установленный навык.

koda skills uninstall [options] <name>

Позиционные аргументы:

Аргумент Обязательный Назначение
name да имя удаляемого навыка

Опции:

Опция Алиас Значения По умолчанию Назначение
--scope -s user, project, workspace user область, из которой удалить

koda skills enable

Включает навык в указанной области настроек.

koda skills enable [options] <name>

Позиционные аргументы:

Аргумент Обязательный Назначение
name да имя включаемого навыка

Опции:

Опция Алиас Значения По умолчанию Назначение
--scope -s user, project, workspace project область включения

Команда удаляет навык из списка отключённых skills.disabled выбранной области. Если навык не найден среди обнаруженных, выводится список доступных навыков.


koda skills disable

Отключает навык в указанной области настроек.

koda skills disable [options] <name>

Позиционные аргументы:

Аргумент Обязательный Назначение
name да имя отключаемого навыка

Опции:

Опция Алиас Значения По умолчанию Назначение
--scope -s user, project, workspace project область отключения

Integrations

v1.2.0

Подробнее — на странице интеграции с Kitty.

Подкоманда koda integrations kitty управляет интеграцией с терминалом Kitty: чатом об истории терминала и подсказками после неудачных команд.

koda integrations kitty <install|status|uninstall|suggest|chat|configure|auto|service> [опции]
Действие Назначение
install установить интеграцию: watcher, конфигурацию Kitty и фоновый сервис
status показать состояние интеграции и параметры чата
uninstall удалить управляемые Koda файлы и фоновый сервис
suggest проанализировать последнюю неудачную команду в текущем окне Kitty
chat открыть чат об истории терминала текущего окна Kitty
configure изменить параметры чата без переустановки
auto <mode> включить или выключить автоматический анализ ошибок (enable/disable)
service <action> управлять фоновым сервисом (status, start, stop, restart)

Опции install:

Опция Значения По умолчанию Назначение
--accept-data-sharing согласие на передачу данных без интерактивного запроса
--timeout-seconds 1–600 30 тайм-аут анализа первой команды
--chat-model идентификатор модели koda-base модель чата
--chat-reasoning none, high high уровень размышлений чата
--chat-max-tokens 128–8192 2048 бюджет токенов ответа чата
--chat-timeout-seconds 1–600 30 тайм-аут отсутствия данных в чате

Опции configure совпадают с --chat-* из install.


Удалённый доступ через Telegram

Подробнее о настройке и командах — на странице удалённого доступа через Telegram.

Удалённый доступ через Telegram управляется слеш-командами внутри сессии, а не подкомандой CLI:

/telegram status
/telegram setup <bot-token>
/telegram link
/telegram relink
/telegram unlink
/telegram disable

/telegram setup сохраняет токен бота в пользовательских настройках и включает удалённый доступ через Telegram. Ссылка привязки владельца появляется в /stats, когда бот подключился. Сценарий рассчитан на одного владельца: один Telegram-пользователь управляет текущим CLI, а удалённые сессии живут только пока этот CLI запущен.

Со стороны Telegram доступны /start <code> для привязки, /new, /model, /stats, /compress, /revert, /delete, /stop, /commit и /unlink.