| 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 | **ओपन सोर्स कोडिंग एजेंट, जो किसी भी मॉडल के साथ काम करता है।** |
| 10 | |
| 11 | Codewhale आपका प्रोजेक्ट पढ़ता है, फ़ाइलें संपादित करता है, कमांड चलाता है और अपने काम की |
| 12 | खुद जाँच करता है — आपके टर्मिनल में, आपके चुने हुए होस्ट किए गए या लोकल मॉडल के साथ। |
| 13 | |
| 14 | [](https://github.com/codewhale-hq/CodeWhale/actions/workflows/ci.yml) |
| 15 | [](https://crates.io/crates/codewhale-cli) |
| 16 | [](https://www.npmjs.com/package/codewhale) |
| 17 | [](LICENSE) |
| 18 | [](https://discord.gg/37gfS3ksug) |
| 19 | |
| 20 | [वेबसाइट](https://codewhale.net) · [दस्तावेज़](docs/README.md) · [बदलावों की सूची](CHANGELOG.md) · [योगदान](CONTRIBUTING.md) |
| 21 | |
| 22 | [English](README.md) · [简体中文](README.zh-CN.md) · [日本語](README.ja-JP.md) · [Tiếng Việt](README.vi.md) · [Bahasa Indonesia](README.id.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) · [Türkçe](README.tr.md) · [Italiano](README.it.md) · [Polski](README.pl.md) · [العربية](README.ar.md) · [Català](README.ca.md) |
| 23 | |
| 24 | <img src="web/public/codewhale-tui-8ba2bbf.png" alt="टर्मिनल में चलता Codewhale सेशन" width="760"> |
| 25 | |
| 26 | <sub>नए इंस्टॉल का असली टर्मिनल कैप्चर — कोई तैयार किया हुआ आउटपुट नहीं।</sub> |
| 27 | |
| 28 | </div> |
| 29 | |
| 30 | ## इंस्टॉल करें |
| 31 | |
| 32 | macOS और Linux: |
| 33 | |
| 34 | ```bash |
| 35 | curl -fsSL https://codewhale.net/install.sh | sh |
| 36 | ``` |
| 37 | |
| 38 | इंस्टॉलर चेकसम से सत्यापित बाइनरी `~/.local/bin` में डाउनलोड करता है। अगर इसके बाद |
| 39 | `codewhale` चलाने पर "command not found" दिखे, तो इंस्टॉलर जो एक PATH लाइन प्रिंट |
| 40 | करता है उसे चलाएँ, या [इसे PATH में जोड़ें](docs/INSTALL.md#put-it-on-your-path) देखें। |
| 41 | कभी भी `codewhale update` से अपग्रेड करें। |
| 42 | |
| 43 | <details> |
| 44 | <summary><b>Windows, npm, Cargo और अन्य तरीके</b></summary> |
| 45 | |
| 46 | ```bash |
| 47 | winget install HunterBown.CodeWhale # Windows x64 (or Scoop, or the installer from GitHub Releases) |
| 48 | npm install -g codewhale # wraps the same release binaries |
| 49 | cargo install codewhale-cli --locked # build from crates.io |
| 50 | ``` |
| 51 | |
| 52 | Docker, Linux पर Nix और Homebrew, Android/Termux, चेकसम सत्यापन के साथ मैन्युअल |
| 53 | डाउनलोड और वैकल्पिक CNB मिरर [इंस्टॉलेशन गाइड](docs/INSTALL.md) में दिए गए हैं। |
| 54 | कोई एक तरीका चुनें: एक मशीन पर कई इंस्टॉलेशन `PATH` को लेकर आपस में टकराते हैं। |
| 55 | |
| 56 | </details> |
| 57 | |
| 58 | ## क्विकस्टार्ट |
| 59 | |
| 60 | 1. **अपना प्रोजेक्ट खोलें।** जिस फ़ोल्डर में काम करना है, उसमें `codewhale` चलाएँ। |
| 61 | 2. **कोई मॉडल जोड़ें।** होस्टेड कुंजी जोड़ने या कोई लोकल रनटाइम चुनने के लिए `/provider` |
| 62 | चलाएँ (या `F3` दबाएँ)। अगर Ollama पहले से किसी चैट मॉडल के साथ चल रहा है, तो |
| 63 | Codewhale अपने-आप उस पर चला जाता है। मॉडल बदलने के लिए `/model` इस्तेमाल करें। |
| 64 | 3. **कोई ठोस काम बताएँ।** |
| 65 | |
| 66 | ```text |
| 67 | Fix the failing tests and explain what changed. |
| 68 | ``` |
| 69 | |
| 70 | यही काम किसी स्क्रिप्ट या CI जॉब से बिना इंटरफ़ेस के भी चलता है: |
| 71 | |
| 72 | ```bash |
| 73 | codewhale exec "fix the failing tests and explain what changed" |
| 74 | ``` |
| 75 | |
| 76 | कमांड और कीबोर्ड शॉर्टकट देखने के लिए `/help` चलाएँ। |
| 77 | |
| 78 | ## इसे चलाने के तरीके |
| 79 | |
| 80 | हर क्लाइंट उसी लोकल Codewhale Runtime को चलाता है, इसलिए सेशन, टूल और अनुमतियाँ हर जगह |
| 81 | एक जैसे व्यवहार करते हैं। |
| 82 | |
| 83 | | कमांड | क्या करता है | |
| 84 | | --- | --- | |
| 85 | | `codewhale` | इंटरैक्टिव टर्मिनल इंटरफ़ेस | |
| 86 | | `codewhale exec "…"` | किसी स्क्रिप्ट या CI से एक बिना इंटरफ़ेस वाला टर्न, JSON स्ट्रीम के साथ | |
| 87 | | `codewhale web` | `127.0.0.1` पर पैकेज में शामिल [लोकल ब्राउज़र क्लाइंट](docs/WEB.md) | |
| 88 | | `codewhale review --pr N` | सलाह के रूप में [pull request समीक्षा](docs/GITHUB_ACTION.md); पोस्ट करना वैकल्पिक है | |
| 89 | | Runtime API | थ्रेड, इवेंट और अनुमोदन के लिए [लोकल HTTP API](docs/RUNTIME_API.md) | |
| 90 | |
| 91 | एक नेटिव डेस्कटॉप ऐप (GPUI) साइन-इन किए गए प्रोडक्ट क्लाइंट के रूप में बनाया जा रहा है; |
| 92 | उपलब्धता के लिए [प्रोडक्ट पेज](https://codewhale.net/en/product) देखें। समुदाय द्वारा |
| 93 | अनुरक्षित [VS Code एक्सटेंशन](https://marketplace.visualstudio.com/items?itemName=HengQuWorld.brotherwhale-vscode) |
| 94 | साइडबार से उसी Runtime से जुड़ता है ([सोर्स](https://github.com/HengQuWorld/CodeWhale-VSCode))। |
| 95 | |
| 96 | ## यह क्या करता है |
| 97 | |
| 98 | - **कोई भी मॉडल, कोई बंधन नहीं।** 40 से अधिक बिल्ट-इन प्रोवाइडर रूट — Anthropic, |
| 99 | DeepSeek, Google, Mistral, Moonshot, OpenAI, OpenRouter, xAI और अन्य — साथ ही कोई भी |
| 100 | OpenAI-संगत एंडपॉइंट और Ollama, vLLM या SGLang के ज़रिए लोकल मॉडल। |
| 101 | [प्रोवाइडर](docs/PROVIDERS.md) |
| 102 | - **नियंत्रण आपके पास रहता है।** Plan मोड कुछ बदले बिना पड़ताल करता है; Work और Operate |
| 103 | बदलाव करते हैं। अनुमोदन की स्थितियाँ तय करती हैं कि किस टूल कॉल के लिए आपकी मंज़ूरी |
| 104 | चाहिए, `/undo` और `/restore` वर्कस्पेस के बदलाव वापस लाते हैं, और `/receipts` सेशन की |
| 105 | हर फ़ाइल, कमांड और मंज़ूरी की सूची देता है। [मोड](docs/MODES.md) · |
| 106 | [रसीदें](docs/RECEIPTS.md) |
| 107 | - **लंबे कामों के लिए बना।** स्थायी `/goal` तय करें, सीमित काम |
| 108 | [सब-एजेंटों](docs/SUBAGENTS.md) को सौंपें, खर्च से पहले जाँच के साथ निगरानी में चलने वाली |
| 109 | [एजेंट टीमें](docs/FLEET.md) चलाएँ, या उन्हें रिपॉज़िटरी में रखे |
| 110 | [वर्कफ़्लो](docs/WORKFLOW_AUTHORING.md) के रूप में स्क्रिप्ट करें। |
| 111 | - **जो आप पहले से इस्तेमाल करते हैं, उसे बढ़ाएँ।** [MCP सर्वर](docs/MCP.md) जोड़ें, |
| 112 | [स्किल](docs/SKILLS.md) और [प्लगइन](docs/PLUGINS.md) इंस्टॉल करें, सेशन और टूल |
| 113 | इवेंट पर [हुक](docs/HOOKS.md) चलाएँ, और मौजूदा |
| 114 | [Claude Code प्लगइन](docs/CLAUDE_PLUGIN_COMPAT.md) लोड करें। |
| 115 | - **Computer Use।** शामिल प्लगइन दूसरे ऐप देखने और चलाने के टूल जोड़ता है। इस्तेमाल से |
| 116 | पहले उसके एक्सेस की समीक्षा करें और उसे सक्षम करें। |
| 117 | [गाइड](crates/tui/plugins/computer-use/README.md) |
| 118 | |
| 119 | ## मोड और अनुमतियाँ |
| 120 | |
| 121 | | | कैसे चुनें | विकल्प | |
| 122 | | --- | --- | --- | |
| 123 | | **Mode** — एजेंट क्या कर रहा है | `Tab` या `/mode` | Plan (पड़ताल, कोई बदलाव नहीं) · Work (संपादन और कमांड चलाना) · Operate (नियोजित और सत्यापित चरणों से किसी लक्ष्य तक पहुँचना) | |
| 124 | | **Posture** — पहले कब पूछता है | `Shift+Tab` | Ask · Auto-Review · Full Access | |
| 125 | |
| 126 | Full Access भी नीति की बाध्यकारी सीमाओं का पालन करता है। |
| 127 | [मोड और अनुमतियों की गाइड](docs/MODES.md) हर विकल्प को समझाती है। |
| 128 | |
| 129 | ## सुरक्षा |
| 130 | |
| 131 | Codewhale आपकी मशीन पर उतने ही एक्सेस के साथ चलता है जितना आप उसे देते हैं। अनुमोदन की |
| 132 | स्थितियाँ और रिपॉज़िटरी के नियम एजेंट की गतिविधियों को सीमित करते हैं, और जहाँ समर्थन है |
| 133 | वहाँ कमांड OS सैंडबॉक्स के भीतर चलते हैं (macOS पर Seatbelt; Linux पर bubblewrap वैकल्पिक है)। |
| 134 | कुछ भी भेजे जाने से पहले `/preview-request` सटीक, संपादित (redacted) अनुरोध दिखाता है। |
| 135 | जिन मॉडलों की कीमत ज्ञात नहीं है, उन्हें मुफ़्त बताने के बजाय अज्ञात ही दिखाया जाता है। |
| 136 | |
| 137 | [अधिकार क्रम](docs/AUTHORIZATION_ORDER.md), [सैंडबॉक्सिंग](docs/SANDBOX.md) और |
| 138 | [टेलीमेट्री](docs/TELEMETRY.md) देखें — उपयोग की गिनती डिफ़ॉल्ट रूप से चालू रहती है और |
| 139 | `codewhale config set telemetry false` उसे बंद कर देता है। |
| 140 | |
| 141 | ## दस्तावेज़ |
| 142 | |
| 143 | | यहाँ से शुरू करें | और गहराई में जाएँ | |
| 144 | | --- | --- | |
| 145 | | [इंस्टॉलेशन](docs/INSTALL.md) | [कॉन्फ़िगरेशन](docs/CONFIGURATION.md) | |
| 146 | | [प्रोवाइडर और लोकल मॉडल](docs/PROVIDERS.md) | [आर्किटेक्चर](docs/ARCHITECTURE.md) | |
| 147 | | [मोड और अनुमतियाँ](docs/MODES.md) | [Runtime API](docs/RUNTIME_API.md) | |
| 148 | | [कीबाइंडिंग](docs/KEYBINDINGS.md) | [प्लगइन लेखन](docs/PLUGIN_AUTHORING.md) | |
| 149 | | [GitHub PR समीक्षा](docs/GITHUB_ACTION.md) | [सभी दस्तावेज़](docs/README.md) | |
| 150 | |
| 151 | ## समुदाय |
| 152 | |
| 153 | बग रिपोर्ट, फ़ीचर के सुझाव और pull request का स्वागत है — चाहे आप Codewhale का कई महीनों से |
| 154 | इस्तेमाल कर रहे हों या पहली बार आज़मा रहे हों। अगर कोई प्रोवाइडर उपलब्ध नहीं है या कोई |
| 155 | वर्कफ़्लो असहज है, तो [issue खोलें](https://github.com/codewhale-hq/CodeWhale/issues/new/choose) |
| 156 | या [pull request भेजें](CONTRIBUTING.md)। पहले योगदान का स्वागत है, और स्वीकार किए गए काम का |
| 157 | श्रेय योगदानकर्ताओं के पास रहता है। [रिपॉज़िटरी की संरचना](CONTRIBUTING.md#project-structure) |
| 158 | शुरुआत के लिए अच्छी जगह है। |
| 159 | |
| 160 | [Discord](https://discord.gg/37gfS3ksug) से जुड़ें, या WeChat पर Hunter (`hunterbown`) को जोड़कर |
| 161 | Whale Brothers समूह में शामिल होने के लिए कहें। |
| 162 | |
| 163 | ## इतिहास और लाइसेंस |
| 164 | |
| 165 | Codewhale की शुरुआत `deepseek-tui` के रूप में हुई थी और यह आज भी उस प्रोजेक्ट का कॉन्फ़िगरेशन |
| 166 | और सेशन पढ़ता है। अब यह किसी प्रोवाइडर पर निर्भर नहीं है, स्वतंत्र रूप से अनुरक्षित है और किसी भी |
| 167 | मॉडल प्रोवाइडर से संबद्ध नहीं है। [हर योगदानकर्ता](docs/CONTRIBUTORS.md) और प्रोजेक्ट को आगे |
| 168 | बढ़ाने वाले ओपन सोर्स समुदायों का धन्यवाद। |
| 169 | |
| 170 | [MIT](LICENSE)। अन्य ओपन सोर्स प्रोजेक्ट से लिए और अनुकूलित किए गए हिस्से |
| 171 | [थर्ड-पार्टी नोटिस](docs/THIRD_PARTY_NOTICES.md) में दर्ज हैं। |
| 172 |