@kodadev/koda-cli
v0.3.9
Published
<p align="center"> <img src="./docs-website/assets/logo.svg" alt="Koda CLI" width="96" /> </p>
Readme
Koda CLI
Koda CLI - это AI-ассистент в терминале. Он помогает разбираться в проектах, читать и изменять файлы, запускать команды, искать информацию и доводить задачи до результата прямо из рабочей директории.
CLI подходит для повседневной работы с кодом, документацией, конфигурациями и текстовыми файлами: можно попросить его объяснить проект, найти проблему, подготовить правку, обновить документы, проверить изменения или автоматизировать рутинную операцию.
Быстрый старт
Установите Koda CLI глобально:
npm install -g @kodadev/koda-cliЗапустите в папке проекта:
kodaМожно использовать без глобальной установки:
npx @kodadev/koda-cliМинимальные требования: Node.js 20 или новее, npm, macOS, Linux или Windows.
Вход в аккаунт
При первом запуске Koda CLI предложит войти через Koda Auth.
- Запустите
koda. - Выберите
Login with Koda. - Откройте ссылку из терминала.
- Подтвердите вход в браузере.
- Вернитесь в терминал и продолжайте работу.
Если вы работаете на сервере или через SSH, где браузер не должен открываться автоматически:
NO_BROWSER=1 kodaДанные входа сохраняются локально в ~/.config/koda/credentials.json.
Что можно делать
- Спрашивать, как устроен проект, отдельный файл или фрагмент кода.
- Просить внести изменения в файлы и видеть diff перед применением.
- Запускать тесты, линтеры и другие shell-команды с подтверждением.
- Искать по файлам, добавлять в контекст конкретные пути и каталоги.
- Работать с несколькими директориями в одной сессии.
- Сохранять проектную память в
KODA.mdилиAGENTS.md. - Подключать MCP-серверы, skills и расширения для дополнительных возможностей.
- Использовать контекст из совместимых IDE.
- Сохранять и восстанавливать важные сессии через checkpointing.
Примеры
Запустить интерактивную сессию:
kodaЗадать один вопрос и завершить работу:
koda -p "Кратко объясни этот проект"Начать с вопроса и остаться в интерактивном режиме:
koda -i "Найди слабые места в тестах"Добавить соседние директории в рабочий контекст:
koda --include-directories ../shared,../docsВключить checkpointing для восстановления изменений:
koda --checkpointingПримеры запросов внутри Koda CLI:
Объясни, как устроена авторизация в этом проекте
Найди причину ошибки из этого лога и предложи исправление
Обнови README так, чтобы он был понятен новым пользователям
@src/ Проверь, где не хватает обработки ошибок
!npm testКоманды внутри сессии
Полезные команды начинаются с /, @ или !.
| Команда | Что делает |
| --- | --- |
| /help | показывает справку |
| /auth | открывает настройки входа |
| /model | позволяет выбрать модель |
| /settings | открывает настройки CLI |
| /tools | показывает доступные инструменты |
| /mcp list | показывает подключенные MCP-серверы |
| /memory show | показывает загруженную память |
| /chat save <tag> | сохраняет текущий разговор |
| /chat resume <tag> | восстанавливает сохраненный разговор |
| /restore | восстанавливает файлы из checkpoint-а, если checkpointing включен |
| /bug | помогает подготовить отчет об ошибке |
| /quit | завершает сессию |
@path/to/file добавляет файл или папку в запрос, а !command запускает shell-команду изнутри CLI.
Безопасность и контроль
Koda CLI работает в вашей текущей директории и показывает подтверждения для действий, которые могут изменить файлы, выполнить shell-команду или сохранить память.
Вы управляете доступом через настройки:
- можно ограничить доступные встроенные инструменты;
- можно отключить shell-команды;
- можно включить sandbox;
- можно настроить, какие MCP-серверы и инструменты доступны в сессии;
- можно использовать
.kodaignore, чтобы исключить файлы из контекста.
Перед применением правок CLI показывает diff, чтобы вы могли проверить изменения.
Настройки
Пользовательские настройки хранятся в:
~/.kodacli/settings.jsonНастройки конкретного проекта можно хранить в:
<workspace>/.kodacli/settings.jsonЧасто используемые параметры: модель по умолчанию, язык интерфейса, тема, checkpointing, sandbox, дополнительные директории, правила фильтрации файлов, MCP-серверы, skills и расширения.
Документация
- Установка и запуск
- Аутентификация
- Справочник CLI
- Команды внутри сессии
- Настройки
- Инструменты
- MCP-серверы
- Навыки агента
- IDE-интеграция
- Устранение проблем
Обновление
npm install -g @kodadev/koda-cli@latestПроверить версию и сведения о текущей сессии можно командой:
/aboutУдаление
npm uninstall -g @kodadev/koda-cliПосле удаления могут остаться локальные настройки, память и данные входа:
~/.kodacli
~/.config/koda/credentials.jsonУдаляйте их только если хотите полностью сбросить локальное состояние. Подробнее: удаление CLI.
Поддержка
Если что-то не работает, начните с раздела устранения проблем. Внутри CLI можно выполнить:
/bug log generateКоманда подготовит JSON-лог сессии. Перед отправкой проверьте, что в нем нет чувствительных данных.
