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