CodeWhale Bot
037aab9cf3
Document Work and To-do as the two product concepts, synchronize every shipped locale, publish the six-tool and typed-image contracts, and keep static web generation offline while live GitHub chrome refreshes after deployment.
134 lines
8.3 KiB
Markdown
134 lines
8.3 KiB
Markdown
<!-- source: README.md sha256:4fb18fffb0fe -->
|
|
# Codewhale
|
|
|
|
Một coding agent mã nguồn mở cho terminal của bạn — mang theo model của riêng bạn.
|
|
|
|
Codewhale khởi đầu là một trải nghiệm gốc (native) cho DeepSeek. Từ đó, nó đã
|
|
phát triển thành một dự án do cộng đồng dẫn dắt: một coding harness hợp với một
|
|
cộng đồng quốc tế đang lớn dần và hỗ trợ càng nhiều model cùng provider càng
|
|
tốt — model mở trước tiên, hosted hay local, không cái nào được ưu ái hơn cái
|
|
nào.
|
|
|
|
Đưa cho nó một provider, một model và một nhiệm vụ. Nó đọc code của bạn, sửa
|
|
file, chạy lệnh, kiểm tra công việc của mình, rồi dừng lại khi nhiệm vụ hoàn
|
|
thành hoặc cần đến bạn. Đổi model giữa chừng bằng `/model`. Làm việc tương tác
|
|
trong TUI, hoặc chạy `codewhale exec` trong script và CI. Viết bằng Rust, giấy
|
|
phép MIT, và chạy trên máy của bạn.
|
|
|
|
Điều khác biệt so với các harness khác: **bạn chọn model cho từng vai trò, và
|
|
chúng không cần phải giống nhau.** Một fleet ghim provider, model và mức suy
|
|
luận riêng cho từng vai trò — nên một model nhanh và rẻ có thể điều phối một
|
|
model suy luận đắt tiền, hoặc một builder GLM có thể làm chung việc với một
|
|
reviewer Kimi. Hãy viết vai trò của riêng bạn, constitution của riêng bạn, và
|
|
harness đó là của bạn chứ không phải của chúng tôi.
|
|
|
|
Chúng tôi luôn tìm kiếm người đóng góp và cách cải thiện. Nếu một model hay
|
|
provider bạn dùng còn thiếu, hoặc có gì đó hỏng, báo cho chúng tôi biết là một
|
|
trong những điều hữu ích nhất bạn có thể làm — xem [Đóng góp](#đóng-góp).
|
|
|
|
[English](README.md) · [简体中文](README.zh-CN.md) · [日本語](README.ja-JP.md) · [한국어](README.ko-KR.md) · [Español](README.es-419.md) · [Português](README.pt-BR.md) · [Русский](README.ru.md) · [Українська](README.uk.md) · [Bahasa Indonesia](README.id.md) · [codewhale.net](https://codewhale.net/) · [Docs](docs) · [Changelog](CHANGELOG.md) · [Discord](https://discord.gg/37gfS3ksug)
|
|
|
|
[](https://github.com/Hmbown/CodeWhale/actions/workflows/ci.yml)
|
|
[](https://crates.io/crates/codewhale-cli)
|
|
[](https://www.npmjs.com/package/codewhale)
|
|
[](https://discord.gg/37gfS3ksug)
|
|
|
|
|
|
|
|
## Cài đặt
|
|
|
|
```bash
|
|
npm install -g codewhale
|
|
```
|
|
|
|
Cargo, Docker, Nix, Scoop, archive dựng sẵn, Android/Termux, và một mirror CNB
|
|
cho người dùng không truy cập được GitHub đều được hướng dẫn trong
|
|
[docs/INSTALL.md](docs/INSTALL.md). Chuyển từ `deepseek-tui` sang? Cấu hình và
|
|
session của bạn được giữ nguyên — xem [docs/REBRAND.md](docs/REBRAND.md).
|
|
|
|
## Sử dụng
|
|
|
|
```bash
|
|
codewhale auth set --provider deepseek # or export ANTHROPIC_API_KEY, etc.
|
|
codewhale # open the TUI
|
|
codewhale exec "fix the failing test" # headless
|
|
codewhale web # local browser client on 127.0.0.1
|
|
```
|
|
|
|
|
|
Trong TUI: `/model` đổi provider và model cùng lúc, `/fleet` chạy một đội
|
|
worker, `/undo` hoàn tác lượt gần nhất, và `/restore <N>` đưa workspace về một
|
|
ảnh chụp trước đó (`/restore` không tham số chỉ liệt kê chúng). Khi vùng soạn
|
|
thảo trống, `Tab` chuyển vòng qua Plan / Work / Operate; khi vùng soạn thảo có
|
|
chữ, `Tab` lại hoàn tất lệnh slash và nhắc `@`. `Shift+Tab` chuyển vòng qua tư
|
|
thế quyền Ask / Auto-Review / Full Access bất cứ lúc nào. `!` chạy một lệnh
|
|
shell qua đường phê duyệt bình thường.
|
|
|
|
## Tính năng
|
|
|
|
- **Model nào cũng được, provider nào cũng được.** DeepSeek, Claude, GPT, Kimi,
|
|
GLM, hơn 30 provider, và vLLM, SGLang hay Ollama của riêng bạn — không cần
|
|
key — đều chạy qua một runtime và một bộ công cụ. Ngân sách ngữ cảnh và giá
|
|
lấy từ route thật; giá chưa rõ hiển thị là chưa rõ, chứ không phải $0.
|
|
- **Một harness do bạn viết.** Vai trò là những tệp bạn có thể đọc và sửa — mỗi
|
|
vai trò một model, một tư thế công cụ và các chỉ dẫn thường trực — đặt trong dự
|
|
án để cả nhóm dùng chung, hoặc cạnh các thiết lập cá nhân để đi theo bạn giữa
|
|
các repo. Constitution ghi lại cách bạn muốn agent hành xử trong mọi phiên, để
|
|
harness khớp với cách làm của bạn thay vì của chúng tôi.
|
|
- **Chỉ đọc cho tới khi bạn cho phép thêm.** Chế độ Plan không đổi file, và mọi
|
|
lệnh rủi ro đều qua phê duyệt. Khi một sandbox của hệ điều hành thực sự bọc
|
|
lệnh, Codewhale nói rõ điều đó: Seatbelt trên macOS khi khả dụng, bubblewrap
|
|
tùy chọn trên Linux. `constitution.json` của repo được biên dịch thành các
|
|
chốt chặn ghi mà ngay cả Full Access cũng không thể bỏ qua.
|
|
- **Công việc bạn có thể tiếp tục.** Fleet ghi lại từng bước vào sổ cái chỉ ghi
|
|
thêm, nên `fleet resume` tiếp tục từ chỗ bạn dừng.
|
|
|
|
## Tìm hiểu thêm
|
|
|
|
- [docs/PROVIDERS.md](docs/PROVIDERS.md) — mọi route provider: dịch vụ,
|
|
gateway và cục bộ
|
|
- [docs/FLEET.md](docs/FLEET.md) — fleet, sổ cái và resume
|
|
- [docs/WORKFLOW_EXPERIMENTAL_SEARCH.md](docs/WORKFLOW_EXPERIMENTAL_SEARCH.md) — tìm kiếm thử nghiệm trong Workflow, đã đóng băng và trung lập với provider
|
|
- [docs/CONFIGURATION.md](docs/CONFIGURATION.md) — `config.toml`, hook và
|
|
constitution
|
|
- [docs/AUTHORIZATION_ORDER.md](docs/AUTHORIZATION_ORDER.md) — cách các chế độ,
|
|
hook, quy tắc quyền, mức an toàn tối thiểu, luật của repo, quy trình phê duyệt
|
|
và sandbox phối hợp với nhau
|
|
- [docs/HOOKS.md](docs/HOOKS.md) — mười một sự kiện hook trong vòng đời TUI,
|
|
payload của chúng và ba sự kiện có thể điều hướng một lượt (`codewhale exec`
|
|
và các lệnh con CLI không kích hoạt hook)
|
|
- [docs/WEB.md](docs/WEB.md) — trình duyệt nhúng chỉ chạy trên loopback và
|
|
ranh giới xác thực dùng một lần
|
|
|
|
Mọi thứ còn lại — chế độ, phím tắt, chi tiết sandbox, MCP, runtime API, kiến
|
|
trúc — nằm trong [docs](docs) và trên [codewhale.net](https://codewhale.net/).
|
|
|
|
## Đóng góp
|
|
|
|
Issue, PR, các bước tái hiện lỗi, log và yêu cầu tính năng đều là công việc
|
|
thực sự của dự án ở đây, và những đóng góp đầu tiên luôn được chào đón. Khi một
|
|
PR không thể merge nguyên trạng, maintainer sẽ harvest phần dùng được và tác
|
|
giả vẫn được ghi công — trong commit, trong changelog và trong
|
|
[docs/CONTRIBUTORS.md](docs/CONTRIBUTORS.md).
|
|
|
|
- [Issue đang mở](https://github.com/Hmbown/CodeWhale/issues) — những đóng góp
|
|
đầu tiên phù hợp nằm ở đây
|
|
- [CONTRIBUTING.md](CONTRIBUTING.md) — thiết lập môi trường dev và quy trình PR
|
|
- [docs/CONTRIBUTORS.md](docs/CONTRIBUTORS.md) — tất cả những người đã góp
|
|
phần định hình dự án
|
|
- [Buy me a coffee](https://www.buymeacoffee.com/hmbown)
|
|
|
|
Cảm ơn [DeepSeek](https://github.com/deepseek-ai) vì các model và sự hỗ trợ đã
|
|
khởi đầu dự án, [DataWhale](https://github.com/datawhalechina) 🐋 vì đã chào
|
|
đón chúng tôi vào đại gia đình Whale Brother, và
|
|
[OpenWarp](https://github.com/zerx-lab/warp) cùng
|
|
[Open Design](https://github.com/nexu-io/open-design) vì đã hợp tác xây dựng
|
|
trải nghiệm agent trên terminal.
|
|
|
|
## Giấy phép
|
|
|
|
[MIT](LICENSE). Dự án cộng đồng độc lập; không trực thuộc bất kỳ nhà cung cấp
|
|
model nào.
|
|
|
|
[](https://www.star-history.com/?repos=Hmbown%2FCodeWhale&type=date)
|