cleankoda logo

Erste Schritte mit cleankoda

cleankoda ist ein terminal-nativer AI-Coding-Agent, der den gesamten Entwicklungszyklus von der Ticket-Anforderung bis zum fertigen Pull Request begleitet.

Anstatt Code isoliert in einem Chatfenster zu generieren, arbeitet cleankoda direkt auf Ihrem Dateisystem und führt Änderungen kontrolliert in einer gesandboxten Umgebung aus. Sie behalten dabei stets das Steuer in der Hand: Jeder Schritt – vom Ausführungsplan bis zu den Unified Diffs – wird transparent dargestellt und von Ihnen per Tastatur freigegeben.

Voraussetzungen

Bevor Sie cleankoda installieren, stellen Sie sicher, dass folgende Werkzeuge auf Ihrem System verfügbar sind:

  • Python: Version 3.10 oder neuer.
  • uv: Extrem schneller Python-Paket- und Projektmanager (empfohlen für ein isoliertes Tool-Management).
  • Docker: Wird für das Sandboxing benötigt. cleankoda führt Shell-Befehle, Testläufe und Code-Analysen isoliert in Containern aus, um Ihr Host-System vor unbeabsichtigten Seiteneffekten zu schützen.
  • API-Keys: Mindestens ein API-Schlüssel eines unterstützten LLM-Providers (z. B. Anthropic, OpenAI oder ein lokales Ollama-Setup) sowie API-Tokens für Ihre Issue-Tracker (Jira, GitHub oder Trello).

Installation

Wählen Sie die für Ihr Betriebssystem passende Installationsmethode.

Linux (Empfohlen über das Installationsskript)

Unter Linux installieren Sie cleankoda am schnellsten über das offizielle Shell-Skript. Es prüft die Abhängigkeiten und richtet die ausführbare Datei automatisch in Ihrem Pfad ein:

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

macOS & Windows (Download & uv)

Auf macOS und Windows können Sie cleankoda direkt über das Release-Paket mit uv installieren:

  1. Laden Sie das aktuelle Release-Paket von der Download-Seite oder dem GitHub-Repository herunter.
  2. Installieren Sie das Tool isoliert über uv
uv tool install cleankoda

Tipp: Falls Sie uv noch nicht installiert haben, können Sie es von astral.sh/uv installieren.

Starten

cleankoda wird immer im Wurzelverzeichnis des Projekts gestartet, an dem Sie gerade arbeiten.

1. Im integrierten Terminal Ihrer IDE (Empfohlen)

Für den besten Workflow starten Sie cleankoda im integrierten Terminal Ihres Editors (z. B. VS Code, Cursor, Zed oder Neovim). So sehen Sie Dateiänderungen und Git-Statusanzeigen parallel zu den Diffs im Terminal:

cd /pfad/zu/deinem/projekt
cleankoda

2. Im Standalone-Terminal des Betriebssystems

Alternativ können Sie jedes Standard-Terminal nutzen (z. B. Alacritty, Kitty, WezTerm, iTerm2 oder Windows Terminal):

cd /pfad/zu/deinem/projekt
cleankoda

Beim ersten Start prüft cleankoda die Docker-Verbindung für das Sandboxing, liest den Repository-Kontext ein und öffnet das interaktive TUI-Dashboard.