البداية
ثبّت Codewhale، واربط نموذجك، وأعطه مهمة. إعداد Fleet اختياري.
Install Codewhale
Install the latest release on macOS or Linux, follow any PATH instruction, and check that the version command prints a version. The guide covers Windows and other install options.
Full install guidecurl -fsSL https://codewhale.net/install.sh | sh codewhale --version
Connect your model
Connect a model API with your provider key. The command below saves a DeepSeek key without echoing it. To run a model yourself, see the provider guide.
Connect a providercodewhale auth set --provider deepseek
Ask about one project file
Open an existing project folder in your terminal, start Codewhale, choose Plan, and paste the prompt below into the message box. The model receives the file content it needs to answer.
cd /path/to/your/project codewhale
Set modes and approvalsRead one source file in this project and explain what it does. Cite its file path and the lines that support your explanation. Do not edit files or run commands.
Check the answer against the file
Open the cited file yourself and confirm that the cited lines support the explanation to complete this task. Ask about any mismatch, or use the troubleshooting guide if setup fails or no reply arrives.
Fix a setup or reply problemMark this after comparing the answer with the actual file. This records your confirmation rather than judging the model’s work automatically.
Explore the terminal
Captured views from a local Codewhale demo.
▎ Local demo: add --json to export.py, run tests, and delegate a review. ▏ ☑ Run tests and review the change │ │ │● JSON export is ready. │▏ │▏ Added --json while preserving CSV output. All 3 local tests passed, and the delegated review │▏ found no issues. │▏ │▏ Try: python3 export.py --json ┃▏ ┃▏ This session uses the local website-demo provider. ┃╭──────────────────────────────────────────────────────────────────────────────────────────────────╮│❯ Also cover an empty export. ││ [↵] │╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ ● Full Access Shift+Tab to change ✓ turn completed · 8 tool(s) used · todo_write website-demo · website-demo context 4% ──────────────────────────────────────────────────────────────────────────────────────────────────── Tasks 3 Fleet 1 Terminal Files 2 Context Git Cost × To-do · 3/3 · 0 left 1 · ✓ Inspect the export command completed 2 · ✓ Add the --json flag completed 3 · ✓ Run tests and review the change completed
A follow-up message in the composer, ready to send.
إلى أين بعد ذلك
Review what changed
Review recorded edits, restore available snapshots and get a code review before pushing.
Set modes and approvals
Compare the published release and source-candidate controls, then choose when Codewhale asks for approval.
Connect your tools
Connect an email tool through MCP, then ask Codewhale to turn the messages it can access into an action list.
Run commands on events
Run your own scripts when a session starts, before a tool call, or when a turn ends. Use them to add context, enforce a rule, or send a notification.