| 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.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) |
| 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 |