| 1 | <!-- source: README.md sha256:604da19bff2c --> |
| 2 | <div align="center"> |
| 3 | |
| 4 | <picture> |
| 5 | <source media="(prefers-color-scheme: dark)" srcset="brand/wordmark-inverted.svg"> |
| 6 | <img src="brand/wordmark.svg" alt="Codewhale" width="320"> |
| 7 | </picture> |
| 8 | |
| 9 | **Агент для программирования с открытым исходным кодом, работающий с любой моделью.** |
| 10 | |
| 11 | Codewhale читает ваш проект, редактирует файлы, выполняет команды и проверяет |
| 12 | собственную работу — в вашем терминале, с облачной или локальной моделью на ваш |
| 13 | выбор. |
| 14 | |
| 15 | [](https://github.com/codewhale-hq/CodeWhale/actions/workflows/ci.yml) |
| 16 | [](https://crates.io/crates/codewhale-cli) |
| 17 | [](https://www.npmjs.com/package/codewhale) |
| 18 | [](LICENSE) |
| 19 | [](https://discord.gg/37gfS3ksug) |
| 20 | |
| 21 | [Сайт](https://codewhale.net) · [Документация](docs/README.md) · [Список изменений](CHANGELOG.md) · [Участие в проекте](CONTRIBUTING.md) |
| 22 | |
| 23 | [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) |
| 24 | |
| 25 | <img src="web/public/codewhale-tui-8ba2bbf.png" alt="Сессия Codewhale в терминале" width="760"> |
| 26 | |
| 27 | <sub>Настоящий снимок терминала после чистой установки — без постановочного вывода.</sub> |
| 28 | |
| 29 | </div> |
| 30 | |
| 31 | ## Установка |
| 32 | |
| 33 | macOS и Linux: |
| 34 | |
| 35 | ```bash |
| 36 | curl -fsSL https://codewhale.net/install.sh | sh |
| 37 | ``` |
| 38 | |
| 39 | Установщик скачивает бинарные файлы с проверкой контрольных сумм в |
| 40 | `~/.local/bin`. Если после этого `codewhale` выдаёт "command not found", |
| 41 | выполните строку для PATH, которую выводит установщик, или см. |
| 42 | [Добавление в PATH](docs/INSTALL.md#put-it-on-your-path). Обновляться можно в |
| 43 | любой момент командой `codewhale update`. |
| 44 | |
| 45 | <details> |
| 46 | <summary><b>Windows, npm, Cargo и другие способы</b></summary> |
| 47 | |
| 48 | ```bash |
| 49 | winget install HunterBown.CodeWhale # Windows x64 (or Scoop, or the installer from GitHub Releases) |
| 50 | npm install -g codewhale # wraps the same release binaries |
| 51 | cargo install codewhale-cli --locked # build from crates.io |
| 52 | ``` |
| 53 | |
| 54 | Docker, Nix, Homebrew в Linux, Android/Termux, ручная загрузка с проверкой |
| 55 | контрольных сумм и необязательное зеркало CNB описаны в |
| 56 | [руководстве по установке](docs/INSTALL.md). Выберите один способ: несколько |
| 57 | установок на одной машине начинают конфликтовать из-за `PATH`. |
| 58 | |
| 59 | </details> |
| 60 | |
| 61 | ## Быстрый старт |
| 62 | |
| 63 | 1. **Откройте проект.** Запустите `codewhale` в папке, с которой хотите |
| 64 | работать. |
| 65 | 2. **Подключите модель.** Выполните `/provider` (или нажмите `F3`), чтобы |
| 66 | добавить ключ облачного провайдера или выбрать локальный рантайм. Если Ollama |
| 67 | уже запущена с чат-моделью, Codewhale переключится на неё сам. Сменить модель |
| 68 | можно командой `/model`. |
| 69 | 3. **Дайте конкретную задачу.** |
| 70 | |
| 71 | ```text |
| 72 | Fix the failing tests and explain what changed. |
| 73 | ``` |
| 74 | |
| 75 | Ту же задачу можно выполнить без интерфейса — из скрипта или задания CI: |
| 76 | |
| 77 | ```bash |
| 78 | codewhale exec "fix the failing tests and explain what changed" |
| 79 | ``` |
| 80 | |
| 81 | Команды и сочетания клавиш показывает `/help`. |
| 82 | |
| 83 | ## Способы запуска |
| 84 | |
| 85 | Каждый клиент работает с одним и тем же локальным Runtime Codewhale, поэтому |
| 86 | сессии, инструменты и разрешения везде ведут себя одинаково. |
| 87 | |
| 88 | | Команда | Что делает | |
| 89 | | --- | --- | |
| 90 | | `codewhale` | Интерактивный терминальный интерфейс | |
| 91 | | `codewhale exec "…"` | Один ход без интерфейса из скрипта или CI, с потоковым выводом JSON | |
| 92 | | `codewhale web` | Встроенный [локальный браузерный клиент](docs/WEB.md) на `127.0.0.1` | |
| 93 | | `codewhale review --pr N` | Рекомендательный [обзор pull request](docs/GITHUB_ACTION.md); публикация включается отдельно | |
| 94 | | Runtime API | [Локальный HTTP API](docs/RUNTIME_API.md) для тредов, событий и подтверждений | |
| 95 | |
| 96 | Нативное настольное приложение (GPUI) создаётся как основной клиент для |
| 97 | вошедших в аккаунт пользователей; о его доступности см. на |
| 98 | [странице продукта](https://codewhale.net/en/product). Поддерживаемое |
| 99 | сообществом [расширение для VS Code](https://marketplace.visualstudio.com/items?itemName=HengQuWorld.brotherwhale-vscode) |
| 100 | подключается к тому же Runtime из боковой панели |
| 101 | ([исходный код](https://github.com/HengQuWorld/CodeWhale-VSCode)). |
| 102 | |
| 103 | ## Что он умеет |
| 104 | |
| 105 | - **Любая модель, без привязки.** Более 40 встроенных маршрутов к провайдерам — |
| 106 | Anthropic, DeepSeek, Google, Mistral, Moonshot, OpenAI, OpenRouter, xAI и |
| 107 | другие — плюс любая OpenAI-совместимая конечная точка и локальные модели через |
| 108 | Ollama, vLLM или SGLang. [Провайдеры](docs/PROVIDERS.md) |
| 109 | - **Контроль остаётся за вами.** Режим Plan исследует проект, ничего не меняя; |
| 110 | Work и Operate вносят изменения. Режимы подтверждения определяют, когда вызов |
| 111 | инструмента требует вашего согласия, `/undo` и `/restore` возвращают изменения |
| 112 | в рабочем каталоге, а `/receipts` перечисляет каждый файл, команду и |
| 113 | подтверждение в сессии. [Режимы](docs/MODES.md) · |
| 114 | [Квитанции](docs/RECEIPTS.md) |
| 115 | - **Для долгих задач.** Задайте долговременную `/goal`, поручайте ограниченные |
| 116 | части работы [субагентам](docs/SUBAGENTS.md), запускайте контролируемые |
| 117 | [команды агентов](docs/FLEET.md) с проверкой перед расходами или описывайте их |
| 118 | в виде версионируемых [рабочих процессов](docs/WORKFLOW_AUTHORING.md). |
| 119 | - **Расширяйте то, чем уже пользуетесь.** Подключайте [MCP-серверы](docs/MCP.md), |
| 120 | устанавливайте [навыки](docs/SKILLS.md) и [плагины](docs/PLUGINS.md), запускайте |
| 121 | [хуки](docs/HOOKS.md) на события сессии и инструментов и загружайте |
| 122 | существующие [плагины Claude Code](docs/CLAUDE_PLUGIN_COMPAT.md). |
| 123 | - **Computer Use.** Входящий в комплект плагин добавляет инструменты для |
| 124 | наблюдения за другими приложениями и управления ими. Перед использованием |
| 125 | проверьте его доступ и включите его. |
| 126 | [Руководство](crates/tui/plugins/computer-use/README.md) |
| 127 | |
| 128 | ## Режимы и разрешения |
| 129 | |
| 130 | | | Выбор | Варианты | |
| 131 | | --- | --- | --- | |
| 132 | | **Режим** — чем занят агент | `Tab` или `/mode` | Plan (исследование, без изменений) · Work (правка и запуск) · Operate (ведёт цель через запланированные и проверяемые шаги) | |
| 133 | | **Подтверждение** — когда он спрашивает заранее | `Shift+Tab` | Ask · Auto-Review · Full Access | |
| 134 | |
| 135 | Full Access по-прежнему соблюдает жёсткие границы политики. Каждый вариант |
| 136 | объясняет [руководство по режимам и разрешениям](docs/MODES.md). |
| 137 | |
| 138 | ## Безопасность |
| 139 | |
| 140 | Codewhale работает на вашей машине с теми правами доступа, которые вы ему |
| 141 | дали. Режимы подтверждения и правила репозитория ограничивают действия агента, |
| 142 | а команды выполняются внутри песочницы ОС там, где она поддерживается (Seatbelt |
| 143 | в macOS; bubblewrap в Linux включается отдельно). `/preview-request` показывает |
| 144 | точный запрос с вычеркнутыми секретами до того, как что-либо будет отправлено. |
| 145 | Неизвестные цены моделей остаются неизвестными, а не выдаются за бесплатные. |
| 146 | |
| 147 | См. [порядок авторизации](docs/AUTHORIZATION_ORDER.md), |
| 148 | [песочницу](docs/SANDBOX.md) и [телеметрию](docs/TELEMETRY.md) — счётчики |
| 149 | использования включены по умолчанию, а `codewhale config set telemetry false` |
| 150 | их отключает. |
| 151 | |
| 152 | ## Документация |
| 153 | |
| 154 | | С чего начать | Подробнее | |
| 155 | | --- | --- | |
| 156 | | [Установка](docs/INSTALL.md) | [Конфигурация](docs/CONFIGURATION.md) | |
| 157 | | [Провайдеры и локальные модели](docs/PROVIDERS.md) | [Архитектура](docs/ARCHITECTURE.md) | |
| 158 | | [Режимы и разрешения](docs/MODES.md) | [Runtime API](docs/RUNTIME_API.md) | |
| 159 | | [Сочетания клавиш](docs/KEYBINDINGS.md) | [Создание плагинов](docs/PLUGIN_AUTHORING.md) | |
| 160 | | [Обзор PR в GitHub](docs/GITHUB_ACTION.md) | [Вся документация](docs/README.md) | |
| 161 | |
| 162 | ## Сообщество |
| 163 | |
| 164 | Отчёты об ошибках, идеи и pull request приветствуются — пользуетесь ли вы |
| 165 | Codewhale уже месяцы или пробуете его впервые. Если не хватает провайдера или |
| 166 | какой-то сценарий неудобен, |
| 167 | [откройте issue](https://github.com/codewhale-hq/CodeWhale/issues/new/choose) или |
| 168 | [отправьте pull request](CONTRIBUTING.md). Первые вклады тоже приветствуются, а |
| 169 | авторы сохраняют признание за принятую работу. Хорошая отправная точка — |
| 170 | [структура репозитория](CONTRIBUTING.md#project-structure). |
| 171 | |
| 172 | Присоединяйтесь к [Discord](https://discord.gg/37gfS3ksug) или добавьте Хантера |
| 173 | в WeChat (`hunterbown`) и попросите вступить в группу Whale Brothers. |
| 174 | |
| 175 | ## История и лицензия |
| 176 | |
| 177 | Codewhale начинался как `deepseek-tui` и по-прежнему читает конфигурацию и |
| 178 | сессии того проекта. Теперь он не привязан к провайдерам, развивается независимо |
| 179 | и не связан ни с одним поставщиком моделей. Благодарим |
| 180 | [всех участников](docs/CONTRIBUTORS.md) и сообщества открытого кода, которые |
| 181 | помогли ему вырасти. |
| 182 | |
| 183 | [MIT](LICENSE). Фрагменты, адаптированные из других проектов с открытым |
| 184 | исходным кодом, перечислены в [уведомлениях о сторонних компонентах](docs/THIRD_PARTY_NOTICES.md). |
| 185 |