cleankoda logo

Premiers pas avec cleankoda

cleankoda est un agent de codage IA natif du terminal qui vous guide tout au long du cycle de développement, de la demande d’assistance à la pull request finale.

Au lieu de générer du code de manière isolée dans une fenêtre de chat, cleankoda travaille directement sur votre système de fichiers et exécute les modifications dans un environnement contrôlé et isolé. Vous gardez le contrôle : chaque étape, du plan d’exécution aux différences unifiées, est affichée de manière transparente et validée par vos soins via le clavier.

Prérequis

Avant d’installer cleankoda, assurez-vous que les outils suivants sont disponibles sur votre système :

  • Python : Version 3.10 ou ultérieure.

  • uv : Gestionnaire de paquets et de projets Python extrêmement rapide (recommandé pour la gestion isolée des outils).

  • Docker : Requis pour l’isolation. cleankoda exécute les commandes shell, les tests et les analyses de code dans des conteneurs isolés afin de protéger votre système hôte des effets indésirables.

  • Clés API : Au moins une clé API d’un fournisseur LLM compatible (par exemple, Anthropic, OpenAI ou une installation Ollama locale) et des jetons API pour vos outils de suivi des problèmes (Jira, GitHub ou Trello).

Installation

Choisissez la méthode d’installation adaptée à votre système d’exploitation.

Linux (Recommandé via le script d’installation)

Sous Linux, la méthode la plus rapide pour installer cleankoda est d’utiliser le script shell officiel. Celui-ci vérifie les dépendances et installe automatiquement l’exécutable dans votre PATH.

curl -fsSL https://cleankoda.com/install.sh | bash

macOS et Windows (Téléchargement et uv)

Sous macOS et Windows, vous pouvez installer cleankoda directement à partir du package de distribution à l’aide d’uv :

  1. Téléchargez le dernier package de distribution depuis la page de téléchargement ou le dépôt GitHub.

  2. Installez l’outil à l’aide d’uv.

uv tool install cleankoda

Conseil : Si vous n’avez pas encore installé uv, vous pouvez l’installer depuis astral.sh/uv.

Démarrage

cleankoda démarre toujours à la racine du projet sur lequel vous travaillez.

1. Dans le terminal intégré de votre IDE (Recommandé)

Pour un flux de travail optimal, lancez cleankoda dans le terminal intégré de votre éditeur (par exemple, VS Code, Cursor, Zed ou Neovim). Vous pourrez ainsi visualiser les modifications de fichiers et les mises à jour de l’état Git en même temps que les différences dans le terminal.

cd /pfad/zu/deinem/projekt
cleankoda

2. Dans le terminal intégré du système d’exploitation

Vous pouvez également utiliser n’importe quel terminal standard (par exemple, Alacritty, Kitty, WezTerm, iTerm2 ou le Terminal Windows) :

cd /pfad/zu/deinem/projekt
cleankoda

Au premier lancement, cleankoda vérifie la connexion Docker pour le sandboxing, lit le contexte du dépôt et ouvre le tableau de bord TUI interactif.