Skip to content

Latest commit

 

History

History
190 lines (146 loc) · 13.6 KB

File metadata and controls

190 lines (146 loc) · 13.6 KB
Codewhale

Агент для программирования с открытым исходным кодом, работающий с любой моделью.

Codewhale читает ваш проект, редактирует файлы, выполняет команды и проверяет собственную работу — в вашем терминале, с облачной или локальной моделью на ваш выбор.

CI crates.io npm License: MIT Discord

Сайт · Документация · Список изменений · Участие в проекте

English · 简体中文 · 日本語 · Tiếng Việt · Bahasa Indonesia · 한국어 · Español · Português · Українська · Français · Deutsch · 繁體中文 · हिन्दी · Türkçe · Italiano · Polski · العربية · Català

Сессия Codewhale в терминале

Настоящий снимок терминала Codewhale из настроенного локального демонстрационного сеанса.

Установка

macOS и Linux:

curl -fsSL https://codewhale.net/install.sh | sh

Установщик скачивает бинарные файлы с проверкой контрольных сумм в ~/.local/bin. Если после этого codewhale выдаёт "command not found", выполните строку для PATH, которую выводит установщик, или см. Добавление в PATH. Обновляться можно в любой момент командой codewhale update.

Windows, npm, Cargo и другие способы
winget install HunterBown.CodeWhale  # Windows x64 (or Scoop, or the installer from GitHub Releases)
npm install -g codewhale            # wraps the same release binaries
cargo install codewhale-cli --locked  # build from crates.io

Docker, Nix, Homebrew в Linux, Android/Termux, ручная загрузка с проверкой контрольных сумм и необязательное зеркало CNB описаны в руководстве по установке. Выберите один способ: несколько установок на одной машине начинают конфликтовать из-за PATH.

Быстрый старт

Ключи API ваших провайдеров — в одном месте. Создайте аккаунт Codewhale или выполните codewhale login, чтобы войти. Сохраняйте и обновляйте ключи API в аккаунте, затем используйте их через маршрут моделей Codewhale на устройствах, где вы вошли в аккаунт. Настройка ключей аккаунта. Вход не загружает существующие локальные ключи в аккаунт; локальная работа доступна и без аккаунта.

  1. Откройте проект. Запустите codewhale в папке, с которой хотите работать.
  2. Подключите модель. Выполните /provider (или нажмите F3), чтобы добавить ключ облачного провайдера или выбрать локальный рантайм. Если Ollama уже запущена с чат-моделью, Codewhale переключится на неё сам. Сменить модель можно командой /model.
  3. Дайте конкретную задачу.
Fix the failing tests and explain what changed.

Ту же задачу можно выполнить без интерфейса — из скрипта или задания CI:

codewhale exec "fix the failing tests and explain what changed"

Команды и сочетания клавиш показывает /help.

Способы запуска

Каждый клиент работает с одним и тем же локальным Runtime Codewhale, поэтому сессии, инструменты и разрешения везде ведут себя одинаково.

Команда Что делает
codewhale Интерактивный терминальный интерфейс
codewhale exec "…" Один ход без интерфейса из скрипта или CI, с потоковым выводом JSON
codewhale web Встроенный локальный браузерный клиент на 127.0.0.1
codewhale review --pr N Рекомендательный обзор pull request; публикация включается отдельно
Runtime API Локальный HTTP API для тредов, событий и подтверждений

Нативное настольное приложение (GPUI) создаётся как основной клиент для вошедших в аккаунт пользователей; о его доступности см. на странице продукта. Поддерживаемое сообществом расширение для VS Code подключается к тому же Runtime из боковой панели (исходный код).

Что он умеет

  • Любая модель, без привязки. Более 40 встроенных маршрутов к провайдерам — Anthropic, DeepSeek, Google, Mistral, Moonshot, OpenAI, OpenRouter, xAI и другие — плюс любая OpenAI-совместимая конечная точка и локальные модели через Ollama, vLLM или SGLang. Провайдеры
  • Контроль остаётся за вами. Режим Plan исследует проект, ничего не меняя; Work и Operate вносят изменения. Режимы подтверждения определяют, когда вызов инструмента требует вашего согласия, /undo и /restore возвращают изменения в рабочем каталоге, а /receipts перечисляет каждый файл, команду и подтверждение в сессии. Режимы · Квитанции
  • Для долгих задач. Задайте долговременную /goal, поручайте ограниченные части работы субагентам, запускайте контролируемые команды агентов с проверкой перед расходами или описывайте их в виде версионируемых рабочих процессов.
  • Расширяйте то, чем уже пользуетесь. Подключайте MCP-серверы, устанавливайте навыки и плагины, запускайте хуки на события сессии и инструментов и загружайте существующие плагины Claude Code.
  • Computer Use. Входящий в комплект плагин добавляет инструменты для наблюдения за другими приложениями и управления ими. Перед использованием проверьте его доступ и включите его. Руководство

Режимы и разрешения

Выбор Варианты
Режим — чем занят агент Tab или /mode Plan (исследование, без изменений) · Work (правка и запуск) · Operate (ведёт цель через запланированные и проверяемые шаги)
Подтверждение — когда он спрашивает заранее Shift+Tab Ask · Auto-Review · Full Access

Full Access по-прежнему соблюдает жёсткие границы политики. Каждый вариант объясняет руководство по режимам и разрешениям.

Безопасность

Codewhale работает на вашей машине с теми правами доступа, которые вы ему дали. Режимы подтверждения и правила репозитория ограничивают действия агента, а команды выполняются внутри песочницы ОС там, где она поддерживается (Seatbelt в macOS; bubblewrap в Linux включается отдельно). /preview-request показывает точный запрос с вычеркнутыми секретами до того, как что-либо будет отправлено. Неизвестные цены моделей остаются неизвестными, а не выдаются за бесплатные.

См. порядок авторизации, песочницу и телеметрию — счётчики использования включены по умолчанию, а codewhale config set telemetry false их отключает.

Документация

С чего начать Подробнее
Установка Конфигурация
Провайдеры и локальные модели Архитектура
Режимы и разрешения Runtime API
Сочетания клавиш Создание плагинов
Обзор PR в GitHub Вся документация

Сообщество

Отчёты об ошибках, идеи и pull request приветствуются — пользуетесь ли вы Codewhale уже месяцы или пробуете его впервые. Если не хватает провайдера или какой-то сценарий неудобен, откройте issue или отправьте pull request. Первые вклады тоже приветствуются, а авторы сохраняют признание за принятую работу. Хорошая отправная точка — структура репозитория.

Присоединяйтесь к Discord или добавьте Хантера в WeChat (hunterbown) и попросите вступить в группу Whale Brothers.

История и лицензия

Codewhale начинался как deepseek-tui и по-прежнему читает конфигурацию и сессии того проекта. Теперь он не привязан к провайдерам, развивается независимо и не связан ни с одним поставщиком моделей. Благодарим всех участников и сообщества открытого кода, которые помогли ему вырасти.

MIT. Фрагменты, адаптированные из других проектов с открытым исходным кодом, перечислены в уведомлениях о сторонних компонентах.