Open-source agent for the terminal written in Rust. Use any provider or model. Issues & PRs always welcome
이 번역은 AI가 원문 README를 옮긴 것입니다. 원문이 항상 우선합니다.
어떤 모델과도 함께 동작하는 오픈소스 코딩 에이전트.
Codewhale은 프로젝트를 읽고, 파일을 편집하고, 명령을 실행하며, 스스로 작업을 검증합니다. 사용자가 선택한 호스팅 모델 또는 로컬 모델과 함께 터미널에서 동작합니다.
macOS 및 Linux:
curl -fsSL https://codewhale.net/install.sh | sh
설치 프로그램은 체크섬이 검증된 바이너리를 ~/.local/bin에 내려받습니다. 이후 codewhale 실행 시 "command not found"가 뜬다면 설치 프로그램이 출력한 PATH 한 줄을 실행하거나 Put it on your PATH 문서를 참고하세요.
언제든 codewhale update로 업그레이드할 수 있습니다.
Windows, npm, Cargo 및 기타 경로
winget install HunterBown.CodeWhale # Windows x64 (또는 Scoop, 또는 GitHub Releases의 설치 프로그램)
npm install -g codewhale # 동일한 릴리스 바이너리를 감싼 패키지
cargo install codewhale-cli --locked # crates.io에서 빌드
Docker, Nix, Linux용 Homebrew, Android/Termux, 체크섬 검증을 포함한 수동 다운로드, 그리고 선택적 CNB 미러는 설치 가이드에서 다룹니다. 한 가지 경로만 선택하세요. 한 머신에 여러 설치가 있으면 PATH를 두고 서로 충돌하게 됩니다.
codewhale을 실행합니다./provider를 실행하거나 F3을 눌러 호스팅 키를 추가하거나 로컬 런타임을 선택합니다. Ollama가 이미 채팅 모델과 함께 실행 중이라면 Codewhale이 자동으로 해당 모델로 전환합니다. /model로 모델을 변경할 수 있습니다.Fix the failing tests and explain what changed.
동일한 작업을 스크립트나 CI 작업에서 헤드리스로 실행할 수 있습니다:
codewhale exec "fix the failing tests and explain what changed"
명령과 키보드 단축키는 /help를 실행해 확인하세요.
모든 클라이언트는 동일한 로컬 Codewhale Engine을 구동하므로 세션, 도구, 권한이 어디서나 동일하게 동작합니다.
| 명령 | 하는 일 | ||
|---|---|---|---|
codewhale |
대화형 터미널 인터페이스 | ||
codewhale exec "…" |
스크립트나 CI에서 실행하는 단일 헤드리스 턴, JSON 스트리밍 | ||
codewhale web |
127.0.0.1에서 제공되는 번들 로컬 브라우저 클라이언트 |
||
codewhale review --pr N |
권고성 풀 리퀘스트 리뷰, 게시는 옵트인 | ||
| Runtime API | 스레드, 이벤트, 승인을 위한 로컬 HTTP API |
네이티브 데스크톱 앱(GPUI)이 로그인 기반 제품 클라이언트로 개발 중입니다. 제공 여부는 제품 페이지를 참고하세요. 커뮤니티가 유지 관리하는 VS Code 확장은 사이드바에서 동일한 Engine에 연결됩니다(소스).
/undo와 /restore는 워크스페이스 변경을 복구하며, /receipts는 세션 내 모든 파일, 명령, 승인 내역을 나열합니다. Modes · Receipts/goal을 설정하고, 제한된 작업을 서브 에이전트에 위임하고, 사전 지출 검사를 포함한 감독형 에이전트 팀을 실행하거나, 체크인된 워크플로로 스크립트화할 수 있습니다.| 선택 방법 | 옵션 | |||
|---|---|---|---|---|
| 모드 — 에이전트가 무엇을 하는지 | Tab 또는 /mode |
Plan(탐색, 변경 없음) · Work(편집 및 실행) · Operate(계획되고 검증된 단계를 통해 목표를 수행) | ||
| 자세 — 언제 먼저 물어보는지 | Shift+Tab |
Ask · Auto-Review · Full Access |
Full Access도 강제 정책 경계는 여전히 준수합니다. 각 옵션에 대한 설명은 모드와 권한 가이드에서 확인하세요.
Codewhale은 사용자가 부여한 접근 권한으로 사용자의 머신에서 실행됩니다. 승인 자세와 저장소 규칙이 에이전트가 할 수 있는 일을 제한하며, 지원되는 환경에서는 명령이 OS 샌드박스 내에서 실행됩니다(macOS에서는 Seatbelt, Linux에서는 bubblewrap이 옵트인). /preview-request는 무언가 전송되기 전에 정확한 마스킹된 요청을 보여줍니다. 알 수 없는 모델 가격은 무료로 보고되지 않고 알 수 없는 상태로 유지됩니다.
권한 부여 순서, 샌드박싱, 텔레메트리를 참고하세요. 사용량 집계는 기본적으로 켜져 있으며 codewhale config set telemetry false로 끌 수 있습니다.
| 여기서 시작 | 더 깊이 | ||
|---|---|---|---|
| 설치 | 구성 | ||
| 프로바이더와 로컬 모델 | 아키텍처 | ||
| 모드와 권한 | Runtime API | ||
| 키 바인딩 | 플러그인 작성 | ||
| GitHub PR 리뷰 | 전체 문서 |
버그 리포트, 기능 아이디어, 풀 리퀘스트를 환영합니다. Codewhale을 몇 달간 사용한 분이든 처음 시도하는 분이든 마찬가지입니다. 프로바이더가 빠져 있거나 워크플로가 불편하다면 이슈를 열거나 풀 리퀘스트를 보내주세요. 첫 기여를 환영하며, 기여자는 반영된 작업에 대한 공로를 계속 유지합니다. 저장소 레이아웃이 시작하기 좋은 곳입니다.
Discord에 참여하거나, WeChat에서 Hunter(hunterbown)를 추가해 Whale Brothers 그룹 가입을 요청하세요.
Codewhale은 deepseek-tui로 시작했으며 여전히 해당 프로젝트의 구성과 세션을 읽습니다. 현재는 프로바이더 중립적이며 독립적으로 유지 관리되고, 어떤 모델 프로바이더와도 제휴 관계가 없습니다. 모든 기여자와 성장을 도운 오픈소스 커뮤니티에 감사드립니다.
MIT. 다른 오픈소스 프로젝트에서 각색한 부분은 서드파티 고지에 기록되어 있습니다.