| 1 | <!-- source: README.md sha256:ebf1c69de0dc --> |
| 2 | # Codewhale |
| 3 | |
| 4 | Codewhale — агент с открытым исходным кодом, который читает ваш проект, редактирует файлы, выполняет команды и проверяет свою работу с помощью выбранной вами облачной или локальной модели. Начните с одной задачи в терминале. Для большой работы поручайте её части агентам с разными моделями и ролями. |
| 5 | |
| 6 |  |
| 7 | |
| 8 | *Предварительный вид терминала из сборки v0.9.12, находившейся в разработке.* |
| 9 | |
| 10 | [English](README.md) · [简体中文](README.zh-CN.md) · [日本語](README.ja-JP.md) · [Tiếng Việt](README.vi.md) · [Bahasa Indonesia](README.id.md) · [한국어](README.ko-KR.md) · [Español](README.es-419.md) · [Português](README.pt-BR.md) · [Українська](README.uk.md) · [Français](README.fr.md) · [Deutsch](README.de.md) · [繁體中文](README.zh-TW.md) · [हिन्दी](README.hi.md) · [Türkçe](README.tr.md) · [Italiano](README.it.md) · [Polski](README.pl.md) · [العربية](README.ar.md) · [Català](README.ca.md) |
| 11 | |
| 12 | [](https://github.com/Hmbown/CodeWhale/actions/workflows/ci.yml) |
| 13 | [](https://crates.io/crates/codewhale-cli) |
| 14 | [](https://www.npmjs.com/package/codewhale) |
| 15 | [](https://discord.gg/37gfS3ksug) |
| 16 | |
| 17 | ## Установка |
| 18 | |
| 19 | Для новой установки на macOS или Linux используйте официальный выпуск с GitHub: |
| 20 | |
| 21 | ```bash |
| 22 | curl -fsSL https://codewhale.net/install.sh | sh |
| 23 | "$HOME/.local/bin/codewhale" |
| 24 | ``` |
| 25 | |
| 26 | Установщик выбирает последний опубликованный выпуск. В [журнале изменений](CHANGELOG.md) также описан ещё не опубликованный кандидат следующего выпуска; эти изменения появятся в доступных для скачивания выпусках только после публикации. |
| 27 | |
| 28 | В Windows скачайте подходящий установщик или архив из [GitHub Releases](https://github.com/Hmbown/CodeWhale/releases/latest). Для обновления существующей прямой установки запустите `codewhale update`; для проверки без установки — `codewhale update --check`. Обновление показывает путь к исполняемому файлу и сохраняет более новые сборки. npm и Cargo — дополнительные способы установки. Переход с менеджера пакетов и настройка PATH описаны в [руководстве по установке](docs/INSTALL.md). |
| 29 | |
| 30 | При первом запуске Codewhale поможет подключить провайдера или настроить Codewhale автономно. Для ответов модели требуется подключённая облачная или локальная модель. Codewhale также поддерживает npm и Cargo как дополнительные способы установки, а также Docker, Nix, Scoop, Android/Termux и необязательное зеркало CNB. Для существующих установок через менеджер пакетов предусмотрены инструкции по переходу. См. [помощь по установке и PATH](docs/INSTALL.md). |
| 31 | |
| 32 | Для автодополнения по Tab достаточно одной команды для каждой оболочки — `codewhale completion bash|zsh|fish|powershell|elvish`. См. [автодополнение оболочки](docs/INSTALL.md#8-shell-completions). |
| 33 | |
| 34 | ## Использование |
| 35 | |
| 36 | Откройте терминал в папке проекта и запустите `codewhale`. Выберите провайдера командой `/provider`, а модель — командой `/model`. Затем опишите конкретную задачу: |
| 37 | |
| 38 | ```text |
| 39 | Fix the failing tests and explain what changed. |
| 40 | ``` |
| 41 | |
| 42 | Задачу можно запустить и без открытия TUI: |
| 43 | |
| 44 | ```bash |
| 45 | codewhale exec "fix the failing tests and explain what changed" |
| 46 | ``` |
| 47 | |
| 48 | Codewhale умеет читать ваш репозиторий, редактировать файлы, выполнять команды, проверять результаты и продолжать работу над целью. Используйте `/mode plan` для изучения без изменения файлов и выполнения команд оболочки, а `/mode work` — когда нужны изменения. Нажмите `Shift+Tab`, чтобы выбрать Ask, Auto-Review или Full Access; в [руководстве по режимам и разрешениям](docs/MODES.md) объясняется, что разрешает каждый вариант. |
| 49 | |
| 50 | ## Терминал, приложения и Computer Use |
| 51 | |
| 52 | Терминал и графические клиенты подключаются к Codewhale Runtime, который запускает агента и его инструменты: |
| 53 | |
| 54 | - **Терминал:** `codewhale` открывает интерактивный интерфейс; `codewhale exec` запускает задачу из скрипта или задания CI. |
| 55 | - **Локальный браузер:** `codewhale web` открывает встроенный [локальный веб-клиент](docs/WEB.md) для той же среды выполнения. |
| 56 | - **Настольное приложение Codewhale (GPUI):** нативное настольное приложение GPUI — направление клиента продукта (решение от 2026-09-14; карта этапов — в docs/TRANSITION.md приватного репозитория codehwhale-gpui). Размещённое веб-приложение на app.codewhale.net выводится из эксплуатации поэтапно; маркетинговый сайт, вход, оплата, юридические страницы и страницы загрузки остаются в вебе навсегда. Сведения о доступности приведены на [странице продукта](https://codewhale.net/en/product). |
| 57 | |
| 58 | **Computer Use добавляет инструменты для наблюдения за другими приложениями и взаимодействия с ними.** Плагин включён в текущий исходный код. Перед использованием проверьте запрашиваемый доступ и включите плагин; разрешения ОС и требования платформы по-прежнему действуют. См. включённое в репозиторий [руководство по Computer Use](crates/tui/plugins/computer-use/README.md) и [настройку плагинов](docs/PLUGINS.md). |
| 59 | |
| 60 | Поддерживаемое сообществом расширение CodeWhale для VS Code подключается к локальному Runtime из боковой панели. Установите его из [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=HengQuWorld.brotherwhale-vscode); исходный код — на [GitHub](https://github.com/HengQuWorld/CodeWhale-VSCode). |
| 61 | |
| 62 | ## Почему Codewhale |
| 63 | |
| 64 | - **Выбирайте модели.** Подключайте облачных провайдеров или локальные модели через Ollama, vLLM или SGLang. Используйте `/provider` для смены провайдера, а `/model` — для выбора модели. |
| 65 | - **Сохраняйте контроль.** Проверяйте предлагаемые действия и получившиеся изменения файлов. Настройки подтверждения определяют, когда нужна проверка; Full Access по-прежнему соблюдает жёсткие ограничения политик. `/undo` и `/restore` помогают восстановить рабочую область после изменений. |
| 66 | - **Организуйте длительную работу.** Сохраняйте сеансы, задавайте постоянную `/goal`, проверяйте рабочие процессы перед запуском и координируйте агентов так, чтобы их внутренние инструкции не попадали в вашу переписку. |
| 67 | - **Расширяйте уже настроенного агента.** Подключайте серверы MCP и навыки, настраивайте хуки и храните роли агентов в виде понятных файлов в проекте или личных настройках. |
| 68 | |
| 69 | Выполните `/help` в TUI, чтобы увидеть команды и сочетания клавиш. |
| 70 | |
| 71 | ## Безопасность |
| 72 | |
| 73 | Codewhale работает на вашем компьютере с предоставленным вами доступом. Режимы подтверждения и правила репозитория ограничивают действия агента; дополнительная песочница ОС создаёт более строгую границу выполнения там, где она поддерживается. Неизвестная цена модели отображается как неизвестная, а не как нулевая. |
| 74 | |
| 75 | Точный порядок применения политик описан в разделе [порядок авторизации](docs/AUTHORIZATION_ORDER.md), а локальные настройки — в разделе [конфигурация](docs/CONFIGURATION.md). |
| 76 | |
| 77 | ## Документация |
| 78 | |
| 79 | - [Провайдеры и локальные модели](docs/PROVIDERS.md) |
| 80 | - [Команды агентов](docs/FLEET.md) |
| 81 | - [MCP](docs/MCP.md), [хуки](docs/HOOKS.md) и [конфигурация](docs/CONFIGURATION.md) |
| 82 | - [Локальный веб-клиент](docs/WEB.md) |
| 83 | - [Вся документация](docs) |
| 84 | - [Структура репозитория и руководство для участников](CONTRIBUTING.md#project-structure) |
| 85 | |
| 86 | ## Присоединяйтесь к сообществу |
| 87 | |
| 88 | **Мы рады сообщениям об ошибках, идеям новых функций и pull request**, независимо от того, пользуетесь ли вы Codewhale несколько месяцев или пробуете его впервые. Если нужного провайдера нет, рабочий процесс неудобен или интерфейс терминала мешает работе, [создайте issue](https://github.com/Hmbown/CodeWhale/issues/new/choose) или [отправьте pull request](CONTRIBUTING.md), чтобы мы могли улучшить проект вместе. Мы рады первым вкладам, а авторство принятой работы сохраняется за участниками. |
| 89 | |
| 90 | Присоединяйтесь к [Discord](https://discord.gg/37gfS3ksug) или добавьте Hunter в WeChat (`hunterbown`) и попросите принять вас в группу Whale Brothers. |
| 91 | |
| 92 | ## История проекта |
| 93 | |
| 94 | Codewhale начинался как `deepseek-tui` и по-прежнему сохраняет совместимость с его конфигурацией и сеансами. Теперь он нейтрален к провайдерам, поддерживается независимо и не связан ни с одним поставщиком моделей. |
| 95 | |
| 96 | Спасибо всем участникам и сообществам открытого исходного кода, которые помогли проекту вырасти. См. [список участников](docs/CONTRIBUTORS.md). |
| 97 | |
| 98 | ## Лицензия |
| 99 | |
| 100 | [MIT](LICENSE). Части, адаптированные из других проектов с открытым исходным кодом, указаны в [уведомлениях о сторонних компонентах](docs/THIRD_PARTY_NOTICES.md). |
| 101 |