| 1 | <!-- source: README.md sha256:ebf1c69de0dc --> |
| 2 | # Codewhale |
| 3 | |
| 4 | Codewhale est un agent open source qui lit votre projet, modifie des fichiers, exécute des commandes et vérifie son travail avec un modèle hébergé ou local de votre choix. Commencez par une tâche dans votre terminal. Pour un travail plus important, confiez-en des parties à des agents utilisant différents modèles et rôles. |
| 5 | |
| 6 |  |
| 7 | |
| 8 | *Aperçu du terminal dans une version de développement de la v0.9.12.* |
| 9 | |
| 10 | [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) · [Deutsch](README.de.md) · [繁體中文](README.zh-TW.md) · [हिन्दी](README.hi.md) · [Türkçe](README.tr.md) · [Italiano](README.it.md) · [Polski](README.pl.md) · [العربية](README.ar.md) · [Català](README.ca.md) |
| 11 | |
| 12 | [](https://github.com/Hmbown/CodeWhale/actions/workflows/ci.yml) |
| 13 | [](https://crates.io/crates/codewhale-cli) |
| 14 | [](https://www.npmjs.com/package/codewhale) |
| 15 | [](https://discord.gg/37gfS3ksug) |
| 16 | |
| 17 | ## Installation |
| 18 | |
| 19 | Pour une nouvelle installation sur macOS ou Linux, utilisez la version officielle de GitHub : |
| 20 | |
| 21 | ```bash |
| 22 | curl -fsSL https://codewhale.net/install.sh | sh |
| 23 | "$HOME/.local/bin/codewhale" |
| 24 | ``` |
| 25 | |
| 26 | L’installeur sélectionne la dernière version publiée. Le [journal des modifications](CHANGELOG.md) décrit aussi la version candidate, encore non publiée, de la prochaine version ; ces modifications ne sont incluses dans les téléchargements publiés qu’une fois la version disponible. |
| 27 | |
| 28 | Sur Windows, téléchargez l’installeur ou l’archive adaptés depuis [GitHub Releases](https://github.com/Hmbown/CodeWhale/releases/latest). Pour une installation directe existante, lancez `codewhale update`, ou `codewhale update --check` pour vérifier sans installer. L’outil affiche le chemin de l’exécutable et conserve les versions de développement plus récentes. npm et Cargo sont des options secondaires ; consultez le [guide d’installation](docs/INSTALL.md) pour migrer depuis un gestionnaire de paquets et configurer PATH. |
| 29 | |
| 30 | Au premier lancement, Codewhale vous aide à connecter un fournisseur ou à configurer Codewhale hors ligne. Les réponses nécessitent un modèle hébergé ou local connecté. Codewhale prend aussi en charge npm et Cargo comme options de distribution secondaires, ainsi que Docker, Nix, Scoop, Android/Termux et un miroir CNB facultatif. Les installations existantes gérées par un gestionnaire de paquets reçoivent des instructions de migration. Consultez l’[aide à l’installation et à la configuration du PATH](docs/INSTALL.md). |
| 31 | |
| 32 | L’autocomplétion avec Tab s’active avec une commande par shell — `codewhale completion bash|zsh|fish|powershell|elvish`. Consultez [l’autocomplétion du shell](docs/INSTALL.md#8-shell-completions). |
| 33 | |
| 34 | ## Utilisation |
| 35 | |
| 36 | Ouvrez un terminal dans le dossier de votre projet et lancez `codewhale`. Choisissez votre fournisseur avec `/provider` et votre modèle avec `/model`. Décrivez ensuite une tâche concrète : |
| 37 | |
| 38 | ```text |
| 39 | Fix the failing tests and explain what changed. |
| 40 | ``` |
| 41 | |
| 42 | Vous pouvez aussi exécuter une tâche sans ouvrir la TUI : |
| 43 | |
| 44 | ```bash |
| 45 | codewhale exec "fix the failing tests and explain what changed" |
| 46 | ``` |
| 47 | |
| 48 | Codewhale peut lire votre dépôt, modifier des fichiers, exécuter des commandes, inspecter les résultats et continuer à travailler vers un objectif. Utilisez `/mode plan` pour explorer sans modifier de fichiers ni exécuter de commandes shell, et `/mode work` lorsque vous souhaitez qu’il effectue des modifications. Appuyez sur `Shift+Tab` pour choisir Ask, Auto-Review ou Full Access ; le [guide des modes et des permissions](docs/MODES.md) explique ce que chaque option autorise. |
| 49 | |
| 50 | ## Terminal, applications et Computer Use |
| 51 | |
| 52 | Le terminal et les clients graphiques se connectent au Runtime Codewhale, qui exécute l’agent et ses outils : |
| 53 | |
| 54 | - **Terminal :** `codewhale` ouvre l’interface interactive ; `codewhale exec` exécute une tâche depuis un script ou une tâche de CI. |
| 55 | - **Navigateur local :** `codewhale web` ouvre le [client web local](docs/WEB.md) fourni, qui utilise le même runtime. |
| 56 | - **Application de bureau Codewhale (GPUI) :** l'application de bureau native GPUI est l'orientation du client produit (décision du 2026-09-14 ; la carte des phases est dans docs/TRANSITION.md du dépôt privé codehwhale-gpui). L'application web hébergée sur app.codewhale.net est retirée par étapes ; le site marketing, la connexion, la facturation, les pages légales et de téléchargement restent sur le web de façon permanente. La disponibilité est indiquée sur la [page du produit](https://codewhale.net/en/product). |
| 57 | |
| 58 | **Computer Use ajoute des outils pour observer d’autres applications et interagir avec elles.** Le plugin est inclus dans le code source actuel. Examinez les accès demandés et activez-le avant de l’utiliser ; les permissions du système d’exploitation et les exigences de la plateforme s’appliquent toujours. Consultez le [guide Computer Use](crates/tui/plugins/computer-use/README.md) inclus et la [configuration des plugins](docs/PLUGINS.md). |
| 59 | |
| 60 | Pour VS Code, l’extension CodeWhale maintenue par la communauté se connecte au Runtime local depuis une barre latérale. Installez-la depuis le [marketplace VS Code](https://marketplace.visualstudio.com/items?itemName=HengQuWorld.brotherwhale-vscode) ; le code source est sur [GitHub](https://github.com/HengQuWorld/CodeWhale-VSCode). |
| 61 | |
| 62 | ## Pourquoi Codewhale |
| 63 | |
| 64 | - **Choisissez vos modèles.** Connectez des fournisseurs hébergés ou des modèles locaux via Ollama, vLLM ou SGLang. Utilisez `/provider` pour changer de fournisseur et `/model` pour choisir un modèle. |
| 65 | - **Gardez le contrôle.** Examinez les actions proposées et les modifications de fichiers qui en résultent. Les paramètres d’approbation déterminent quand un examen est nécessaire ; Full Access respecte toujours les limites impératives des politiques. `/undo` et `/restore` aident à récupérer les modifications de l’espace de travail. |
| 66 | - **Organisez les travaux de longue durée.** Enregistrez les sessions, définissez un `/goal` durable, examinez les workflows avant leur exécution et coordonnez des agents sans faire apparaître leurs instructions internes dans votre conversation. |
| 67 | - **Étendez l’agent que vous possédez déjà.** Connectez des serveurs MCP et des compétences, configurez des hooks et conservez les rôles d’agent sous forme de fichiers lisibles dans votre projet ou vos paramètres personnels. |
| 68 | |
| 69 | Exécutez `/help` dans la TUI pour afficher les commandes et les raccourcis clavier. |
| 70 | |
| 71 | ## Sécurité |
| 72 | |
| 73 | Codewhale s’exécute sur votre machine avec les accès que vous lui accordez. Les modes d’approbation et les règles du dépôt limitent les actions de l’agent ; un bac à sable facultatif du système d’exploitation renforce la limite d’exécution lorsqu’il est pris en charge. Le prix d’un modèle inconnu reste indiqué comme tel au lieu d’être présenté comme gratuit. |
| 74 | |
| 75 | Consultez l’[ordre d’autorisation](docs/AUTHORIZATION_ORDER.md) pour connaître la hiérarchie exacte des politiques et la [configuration](docs/CONFIGURATION.md) pour les paramètres locaux. |
| 76 | |
| 77 | ## Documentation |
| 78 | |
| 79 | - [Fournisseurs et modèles locaux](docs/PROVIDERS.md) |
| 80 | - [Équipes d’agents](docs/FLEET.md) |
| 81 | - [MCP](docs/MCP.md), [hooks](docs/HOOKS.md) et [configuration](docs/CONFIGURATION.md) |
| 82 | - [Client web local](docs/WEB.md) |
| 83 | - [Toute la documentation](docs) |
| 84 | - [Organisation du dépôt et guide de contribution](CONTRIBUTING.md#project-structure) |
| 85 | |
| 86 | ## Rejoindre la communauté |
| 87 | |
| 88 | **Les signalements de bugs, les idées de fonctionnalités et les pull requests sont les bienvenus**, que vous utilisiez Codewhale depuis des mois ou que vous l’essayiez pour la première fois. S’il manque un fournisseur, si un workflow est peu pratique ou si l’interface du terminal vous gêne, [ouvrez une issue](https://github.com/Hmbown/CodeWhale/issues/new/choose) ou [envoyez une pull request](CONTRIBUTING.md) pour que nous puissions l’améliorer ensemble. Les premières contributions sont les bienvenues, et les personnes qui contribuent restent créditées pour le travail intégré. |
| 89 | |
| 90 | Rejoignez le [Discord](https://discord.gg/37gfS3ksug), ou ajoutez Hunter sur WeChat (`hunterbown`) et demandez à rejoindre le groupe Whale Brothers. |
| 91 | |
| 92 | ## Historique du projet |
| 93 | |
| 94 | Codewhale a commencé sous le nom de `deepseek-tui` et conserve la compatibilité avec sa configuration et ses sessions. Il est désormais indépendant de tout fournisseur, maintenu de manière autonome et n’est affilié à aucun fournisseur de modèles. |
| 95 | |
| 96 | Merci à toutes les personnes qui contribuent et aux communautés open source qui ont aidé le projet à grandir. Consultez le [registre des contributeurs](docs/CONTRIBUTORS.md). |
| 97 | |
| 98 | ## Licence |
| 99 | |
| 100 | [MIT](LICENSE). Les parties adaptées d’autres projets open source sont répertoriées dans les [mentions relatives aux logiciels tiers](docs/THIRD_PARTY_NOTICES.md). |
| 101 |