| 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 | **Agen pengodean sumber terbuka yang bekerja dengan model apa pun.** |
| 10 | |
| 11 | Codewhale membaca proyek Anda, mengedit berkas, menjalankan perintah, dan |
| 12 | memeriksa pekerjaannya sendiri, di terminal Anda, dengan model hosted atau lokal |
| 13 | pilihan Anda. |
| 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 | [Situs web](https://codewhale.net) · [Dokumentasi](docs/README.md) · [Changelog](CHANGELOG.md) · [Berkontribusi](CONTRIBUTING.md) |
| 22 | |
| 23 | [English](README.md) · [简体中文](README.zh-CN.md) · [日本語](README.ja-JP.md) · [Tiếng Việt](README.vi.md) · [한국어](README.ko-KR.md) · [Español](README.es-419.md) · [Português](README.pt-BR.md) · [Русский](README.ru.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="Sesi terminal Codewhale" width="760"> |
| 26 | |
| 27 | <sub>Tangkapan terminal sungguhan dari instalasi baru, tanpa keluaran yang direkayasa.</sub> |
| 28 | |
| 29 | </div> |
| 30 | |
| 31 | ## Instalasi |
| 32 | |
| 33 | macOS dan Linux: |
| 34 | |
| 35 | ```bash |
| 36 | curl -fsSL https://codewhale.net/install.sh | sh |
| 37 | ``` |
| 38 | |
| 39 | Installer mengunduh biner yang checksum-nya sudah diverifikasi ke `~/.local/bin`. |
| 40 | Jika setelah itu `codewhale` menampilkan "command not found", jalankan satu baris |
| 41 | PATH yang dicetak installer, atau lihat |
| 42 | [Menambahkan ke PATH](docs/INSTALL.md#put-it-on-your-path). |
| 43 | Anda dapat memperbarui kapan saja dengan `codewhale update`. |
| 44 | |
| 45 | <details> |
| 46 | <summary><b>Windows, npm, Cargo, dan cara lain</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 di Linux, Android/Termux, unduhan manual dengan verifikasi |
| 55 | checksum, dan mirror CNB opsional dibahas di |
| 56 | [panduan instalasi](docs/INSTALL.md). Pilih satu cara: beberapa instalasi pada |
| 57 | satu mesin akan saling berebut `PATH`. |
| 58 | |
| 59 | </details> |
| 60 | |
| 61 | ## Mulai cepat |
| 62 | |
| 63 | 1. **Buka proyek Anda.** Jalankan `codewhale` di folder yang ingin Anda kerjakan. |
| 64 | 2. **Hubungkan model.** Jalankan `/provider` (atau tekan `F3`) untuk menambahkan |
| 65 | kunci model hosted atau memilih runtime lokal. Jika Ollama sudah berjalan |
| 66 | dengan model obrolan, Codewhale beralih ke model itu secara otomatis. Gunakan |
| 67 | `/model` untuk mengganti model. |
| 68 | 3. **Berikan tugas yang konkret.** |
| 69 | |
| 70 | ```text |
| 71 | Fix the failing tests and explain what changed. |
| 72 | ``` |
| 73 | |
| 74 | Tugas yang sama dapat dijalankan secara headless dari skrip atau job CI: |
| 75 | |
| 76 | ```bash |
| 77 | codewhale exec "fix the failing tests and explain what changed" |
| 78 | ``` |
| 79 | |
| 80 | Jalankan `/help` untuk melihat perintah dan pintasan keyboard. |
| 81 | |
| 82 | ## Cara menjalankannya |
| 83 | |
| 84 | Setiap klien mengendalikan Codewhale Runtime lokal yang sama, sehingga sesi, |
| 85 | alat, dan izin berperilaku sama di mana pun. |
| 86 | |
| 87 | | Perintah | Fungsinya | |
| 88 | | --- | --- | |
| 89 | | `codewhale` | Antarmuka terminal interaktif | |
| 90 | | `codewhale exec "…"` | Satu giliran headless dari skrip atau CI, dengan keluaran JSON streaming | |
| 91 | | `codewhale web` | [Klien peramban lokal](docs/WEB.md) bawaan di `127.0.0.1` | |
| 92 | | `codewhale review --pr N` | [Tinjauan pull request](docs/GITHUB_ACTION.md) yang bersifat saran; pengiriman hasilnya opsional | |
| 93 | | Runtime API | [API HTTP lokal](docs/RUNTIME_API.md) untuk thread, event, dan persetujuan | |
| 94 | |
| 95 | Aplikasi desktop native (GPUI) sedang dibangun sebagai klien produk untuk akun |
| 96 | yang masuk; lihat ketersediaannya di |
| 97 | [halaman produk](https://codewhale.net/en/product). |
| 98 | [Ekstensi VS Code](https://marketplace.visualstudio.com/items?itemName=HengQuWorld.brotherwhale-vscode) |
| 99 | yang dipelihara komunitas terhubung ke Runtime yang sama dari sidebar |
| 100 | ([sumber](https://github.com/HengQuWorld/CodeWhale-VSCode)). |
| 101 | |
| 102 | ## Apa yang bisa dilakukan |
| 103 | |
| 104 | - **Model apa pun, tanpa terkunci.** Lebih dari 40 rute penyedia bawaan, |
| 105 | termasuk Anthropic, DeepSeek, Google, Mistral, Moonshot, OpenAI, OpenRouter, |
| 106 | xAI, dan lainnya, ditambah endpoint apa pun yang kompatibel dengan OpenAI dan |
| 107 | model lokal melalui Ollama, vLLM, atau SGLang. [Penyedia](docs/PROVIDERS.md) |
| 108 | - **Kendali tetap di tangan Anda.** Mode Plan menelusuri tanpa mengubah apa pun; |
| 109 | Work dan Operate membuat perubahan. Posture persetujuan menentukan kapan |
| 110 | pemanggilan alat memerlukan persetujuan Anda, `/undo` dan `/restore` |
| 111 | memulihkan perubahan di workspace, dan `/receipts` mencantumkan setiap berkas, |
| 112 | perintah, dan persetujuan dalam satu sesi. [Mode](docs/MODES.md) · |
| 113 | [Receipt](docs/RECEIPTS.md) |
| 114 | - **Dibuat untuk pekerjaan panjang.** Tetapkan `/goal` yang tahan lama, |
| 115 | delegasikan pekerjaan terbatas ke [sub-agen](docs/SUBAGENTS.md), jalankan |
| 116 | [tim agen](docs/FLEET.md) yang diawasi dengan pemeriksaan biaya sebelum |
| 117 | berjalan, atau buat skripnya sebagai [workflow](docs/WORKFLOW_AUTHORING.md) yang |
| 118 | disimpan di repositori. |
| 119 | - **Perluas yang sudah Anda gunakan.** Hubungkan [server MCP](docs/MCP.md), pasang |
| 120 | [skill](docs/SKILLS.md) dan [plugin](docs/PLUGINS.md), jalankan |
| 121 | [hook](docs/HOOKS.md) pada event sesi dan alat, serta muat |
| 122 | [plugin Claude Code](docs/CLAUDE_PLUGIN_COMPAT.md) yang sudah ada. |
| 123 | - **Computer Use.** Plugin bawaan menambahkan alat untuk mengamati dan |
| 124 | mengoperasikan aplikasi lain. Tinjau akses yang diminta dan aktifkan sebelum |
| 125 | digunakan. [Panduan](crates/tui/plugins/computer-use/README.md) |
| 126 | |
| 127 | ## Mode dan izin |
| 128 | |
| 129 | | | Pilih dengan | Opsi | |
| 130 | | --- | --- | --- | |
| 131 | | **Mode** — apa yang sedang dikerjakan agen | `Tab` atau `/mode` | Plan (menelusuri, tanpa perubahan) · Work (mengedit dan menjalankan) · Operate (menuntaskan tujuan lewat langkah yang direncanakan dan diverifikasi) | |
| 132 | | **Posture** — kapan agen bertanya lebih dulu | `Shift+Tab` | Ask · Auto-Review · Full Access | |
| 133 | |
| 134 | Full Access tetap menghormati batasan kebijakan yang bersifat mutlak. |
| 135 | [Panduan mode dan izin](docs/MODES.md) menjelaskan setiap opsi. |
| 136 | |
| 137 | ## Keamanan |
| 138 | |
| 139 | Codewhale berjalan di mesin Anda dengan akses yang Anda berikan. Posture |
| 140 | persetujuan dan aturan repositori membatasi apa yang boleh dilakukan agen, dan |
| 141 | perintah dijalankan di dalam sandbox OS jika didukung (Seatbelt di macOS; |
| 142 | bubblewrap di Linux bersifat opsional). `/preview-request` menampilkan permintaan |
| 143 | persis yang sudah disamarkan sebelum apa pun dikirim. Harga model yang tidak |
| 144 | diketahui tetap dicatat sebagai tidak diketahui, bukan dilaporkan gratis. |
| 145 | |
| 146 | Lihat [urutan otorisasi](docs/AUTHORIZATION_ORDER.md), |
| 147 | [sandbox](docs/SANDBOX.md), dan [telemetri](docs/TELEMETRY.md): penghitungan |
| 148 | penggunaan aktif secara default dan `codewhale config set telemetry false` |
| 149 | menonaktifkannya. |
| 150 | |
| 151 | ## Dokumentasi |
| 152 | |
| 153 | | Mulai dari sini | Pelajari lebih dalam | |
| 154 | | --- | --- | |
| 155 | | [Instalasi](docs/INSTALL.md) | [Konfigurasi](docs/CONFIGURATION.md) | |
| 156 | | [Penyedia dan model lokal](docs/PROVIDERS.md) | [Arsitektur](docs/ARCHITECTURE.md) | |
| 157 | | [Mode dan izin](docs/MODES.md) | [Runtime API](docs/RUNTIME_API.md) | |
| 158 | | [Pintasan keyboard](docs/KEYBINDINGS.md) | [Penulisan plugin](docs/PLUGIN_AUTHORING.md) | |
| 159 | | [Tinjauan PR GitHub](docs/GITHUB_ACTION.md) | [Seluruh dokumentasi](docs/README.md) | |
| 160 | |
| 161 | ## Komunitas |
| 162 | |
| 163 | Laporan bug, ide fitur, dan pull request sangat disambut, baik Anda sudah |
| 164 | berbulan-bulan memakai Codewhale maupun baru mencobanya. Jika ada penyedia yang |
| 165 | belum ada atau alur kerja yang terasa canggung, |
| 166 | [buka issue](https://github.com/codewhale-hq/CodeWhale/issues/new/choose) atau |
| 167 | [kirim pull request](CONTRIBUTING.md). Kontribusi pertama disambut, dan |
| 168 | kontributor tetap mendapat kredit atas pekerjaan yang digabungkan. |
| 169 | [Struktur repositori](CONTRIBUTING.md#project-structure) adalah tempat yang baik |
| 170 | untuk memulai. |
| 171 | |
| 172 | Bergabunglah di [Discord](https://discord.gg/37gfS3ksug), atau tambahkan Hunter |
| 173 | di WeChat (`hunterbown`) dan minta bergabung ke grup Whale Brothers. |
| 174 | |
| 175 | ## Sejarah dan lisensi |
| 176 | |
| 177 | Codewhale berawal dari `deepseek-tui` dan masih membaca konfigurasi serta sesi |
| 178 | proyek itu. Kini proyek ini netral terhadap penyedia, dipelihara secara mandiri, |
| 179 | dan tidak berafiliasi dengan penyedia model mana pun. Terima kasih kepada |
| 180 | [setiap kontributor](docs/CONTRIBUTORS.md) dan komunitas sumber terbuka yang |
| 181 | membantunya berkembang. |
| 182 | |
| 183 | [MIT](LICENSE). Bagian yang diadaptasi dari proyek sumber terbuka lain dicatat di |
| 184 | [pemberitahuan pihak ketiga](docs/THIRD_PARTY_NOTICES.md). |
| 185 |