2026-08-17 का अंक
v0.9.9
Codewhaleकोई भी मॉडल, आपकी मशीन पर
★ GitHub
Codewhale documentation

Find the guidance you need.

Start with the getting-started guide and installation, or go straight to vocabulary, modes, permissions, tools, providers, Fleet, hooks, MCP, and the Runtime API. These pages are the product documentation; each one cites the source documents in the repository for full detail.

Install CodewhaleBrowse source docs ↗

शुरुआत कैसे करें

एक इंस्टॉल कमांड से लेकर आपके काम के लिए तैयार Fleet तक, चार कदम। हर कदम केवल वही बताता है जो वर्तमान कैंडिडेट वास्तव में करता है; जो अप्रकाशित या अभिलिखित-नहीं है, वह स्पष्ट रूप से चिह्नित है।

  1. Install Codewhale

    One npm command installs the dispatcher and terminal runtime. Cargo, archives, Docker, Nix, and China mirrors are documented alternatives — published releases only.

    npm install -g codewhale
codewhale doctor
    Full install guide →

  2. Open a first session — no key needed

    Launches without any API key: short constitution-first setup, then the full interface. Explore in Plan mode — always read-only. Model replies need a provider; that's the next step.

    codewhale
    Learn the product nouns first →

  3. Connect a provider

    Pick a supported route — hosted key, gateway, or keyless local runtime (Ollama, vLLM, SGLang). Provider and model stay explicit; reasoning and routing provenance stay separate, and unavailable values stay unavailable.

    codewhale auth set --provider deepseek
    Providers and models →

  4. Set up your ideal fleet

    Add every provider you use — one auth set per hosted route; keyless local runtimes need nothing — then author the team: /fleet setup walks one role at a time (a model from any configured provider, a thinking tier, permissions) and saves a reusable profile for this repo or every repo on this machine. Fleet state lives in the workspace ledger; ordinary single tasks need none of this.

    /fleet setup
codewhale fleet status
    Fleet and Workflow docs →

एक असली सेशन देखें

नीचे असली-सेशन मीडिया की जगह है। यह जानबूझकर प्रतीक्षारत स्थिति में है: जब तक v0.9.2 कैंडिडेट की dogfood रिकॉर्डिंग मौजूद नहीं है, यह साइट कोई प्लेसहोल्डर या नकली फ़ुटेज नहीं दिखाती।

Recording pending release candidate

No placeholder or staged footage is shown here. When the recording exists, the real session ships with a poster frame, bilingual captions, a transcript, and an optional GIF fallback download.

A real Codewhale session, end to endWill be recorded from the v0.9.4 release candidate during dogfood: install, first offline session, provider connection, and one Fleet workflow on a sealed local route. Until that recording exists, no footage is shown here — the manifest and budgets above are the contract it must satisfy.Recording plan and acceptance checklist ↗

आगे क्या

Hooks

React to lifecycle events — before and after tool calls, on turn end, on session events — with project-local trust rules.

Modes and permission postures

Plan / Work / Operate and Ask / Auto-Review / Full Access, exactly as the runtime enforces them.

Documentation hub

Every topic, searchable, each page citing its source document in the repository.

स्रोत दस्तावेज़: docs/GUIDE.md, docs/KEYBINDINGS.md · कदमों का पाठ web/lib/content/getting-started.ts में है; बदलाव पर docs-map.ts भी अपडेट करें।