Zum Inhalt springen

CLI-Referenz

Die Planu CLI (planu) ermöglicht es, Planu vom Terminal aus zu verwalten — in KI-Tools installieren, Specs validieren, Audits ausführen und vieles mehr.

Schnellstart

bash
npm install -g @planu/cli
planu <command>

# Oder ohne globale Installation
npx @planu/cli@latest <command>

Befehle

planu install

Erkennt installierte KI-Tools (Claude Code, Cursor, Windsurf, Zed, Cline, Continue) und fügt den Planu-MCP-Eintrag in deren Konfigurationsdateien ein.

bash
planu install [--scope user|project] [--all]
FlagBeschreibung
--scope user|projectAuf Benutzer- (global) oder Projektebene installieren. Wird abgefragt, wenn weggelassen.
--allAuswahlmenü überspringen und in allen erkannten Tools installieren.
bash
# interaktive Installation
planu install

# in allen erkannten Tools auf Benutzerebene ohne Interaktion installieren
planu install --scope user --all

planu doctor

Prüft alle bekannten Konfigurationspfade jedes KI-Tools und meldet, ob der Planu-MCP-Eintrag vorhanden, fehlend oder fehlerhaft ist.

bash
planu doctor

Beispielausgabe:

Planu Doctor

  [+] Claude Code (user)    OK  ~/.claude.json
  [-] Cursor                not installed
  [?] Zed                   tool not found

Planu is installed in 1 location(s). Run `planu install` to add more.

planu uninstall

Findet alle Konfigurationsdateien, die einen Planu-MCP-Eintrag enthalten, und entfernt diesen nach Bestätigung.

bash
planu uninstall [--yes]
FlagBeschreibung
--yes / -yBestätigungsabfrage überspringen (nützlich in Skripten).

planu status

Aktualisiert den Status einer Spec (z. B. von draft zu approved).

bash
planu status <specId> --set <status> [--project-id ID] [--notes "..."]
FlagBeschreibung
--set / -sNeuer Status: draft, review, approved, implementing, done, blocked.
--notes / -nOptionale Reviewnotizen, die mit dem Übergang verknüpft werden.
--project-idProjekt-ID. Wird automatisch aus dem aktuellen Verzeichnis erkannt, wenn weggelassen.
bash
planu status SPEC-042 --set approved
planu status SPEC-042 --set done --notes "Alle Kriterien verifiziert"

planu validate

Validiert eine Spec gegen ihren Quellcode — prüft, welche Akzeptanzkriterien abgedeckt sind, und meldet die Gesamtabdeckung.

bash
planu validate <specId> [--project-id ID]
bash
planu validate SPEC-042
planu validate SPEC-042 --project-id 1ef29aa7362bb087

planu audit

Führt ein Code-Qualitäts-Audit am Projekt durch und bewertet es von 0 bis 100 nach SOLID-Prinzipien, Clean Code und Architekturkonformität.

bash
planu audit [--path .] [--project-id ID] [--spec SPEC-001]
FlagBeschreibung
--path / -pZu prüfendes Verzeichnis. Standard: aktuelles Verzeichnis.
--spec / -sAudit auf eine bestimmte Spec beschränken.
--project-idProjekt-ID. Wird automatisch erkannt, wenn weggelassen.

planu estimate

Schätzt den Implementierungsaufwand einer Spec — Stunden, Komplexität und Kostenaufschlüsselung.

bash
planu estimate <specId> [--project-id ID]
bash
planu estimate SPEC-042

planu create

Erstellt eine neue Spec mit Titel und optionalen Metadaten.

bash
planu create <title> [--type feature] [--description "..."] [--path .]
FlagBeschreibung
--type / -tSpec-Typ: feature, fix, chore, spike.
--description / -dKurze Beschreibung. Verwendet den Titel, wenn weggelassen.
--path / -pProjektverzeichnis. Standard: aktuelles Verzeichnis.
--scopeGeltungsbereich der Spec.
--targetZielebene oder -modul.
--featureÜbergeordnete Funktionsgruppe.
bash
planu create "OAuth-Login hinzufügen" --type feature
planu create "Null-Pointer beim Checkout beheben" --type fix --description "Null-Pointer wenn der Warenkorb leer ist"

planu list

Listet alle Specs im aktuellen Projekt auf, optional gefiltert nach Status oder Typ.

bash
planu list [--status draft] [--type feature] [--project-id ID]
FlagBeschreibung
--status / -sNach Status filtern: draft, review, approved, implementing, done, blocked.
--type / -tNach Typ filtern: feature, fix, chore, spike.
--project-idProjekt-ID. Wird automatisch erkannt, wenn weggelassen.
bash
planu list
planu list --status approved
planu list --type fix --status done

planu init

Initialisiert ein Verzeichnis als Planu-Projekt — scannt den Technologie-Stack, konfiguriert die Sprache und erstellt die Projektmetadaten.

bash
planu init [path] [--locale en] [--rate 100] [--level junior|mid|senior] [--profile developer]
FlagBeschreibung
--locale / -lSprache für Spec-Inhalte: en, es, pt, fr, de, zh.
--rate / -rStundensatz in USD für Kostenschätzungen.
--levelErfahrungsstufe: junior, mid, senior.
--profileBenutzerprofil: developer, product-owner, designer, non-technical.
bash
planu init
planu init /pfad/zum/projekt --locale de --rate 90

planu serve

Startet den Planu-MCP-Server mit HTTP-Transport statt stdio. Nützlich für Remote- oder browserbasierte Clients.

bash
planu serve [--port 3100]
bash
planu serve --port 8080

planu dashboard

Öffnet das Planu-Web-Dashboard — eine lokale Browser-Oberfläche zum Durchsuchen von Specs, Metriken und Berichten.

bash
planu dashboard [--port 5050]
bash
planu dashboard
planu dashboard --port 9000

planu watch

Überwacht ein Projektverzeichnis auf Dateiänderungen und löst konfigurierte Hook-Handler aus (on-save, on-create, on-delete).

bash
planu watch [path] [--hooks on-save,on-create] [--verbose] [--dry-run]
FlagBeschreibung
--hooks / -HKommagetrennte Hook-Typen. Standard: on-save,on-create,on-delete.
--verbose / -VDetaillierte Hook-Ausführungsprotokolle anzeigen.
--dry-runVorschau der auszulösenden Hooks, ohne sie auszuführen.
bash
planu watch
planu watch /pfad/zum/projekt --hooks on-save --verbose
planu watch --dry-run

planu handoff

Erstellt einen strukturierten Handoff-Prompt, damit ein KI-Agent eine Spec autonom implementieren kann.

bash
planu handoff <specId> [--name Agent-1] [--role implementer] [--files src/a.ts,src/b.ts]
FlagBeschreibung
--name / -nAgentenname. Standard: Agent-1.
--role / -rAgentenrolle: implementer, reviewer, tester. Standard: implementer.
--files / -fKommagetrennte Liste der diesem Agenten zugewiesenen Dateien.
--project-idProjekt-ID. Wird automatisch erkannt, wenn weggelassen.
bash
planu handoff SPEC-042
planu handoff SPEC-042 --name "Backend-Agent" --role implementer --files src/api/auth.ts,src/middleware/jwt.ts

Typische Arbeitsabläufe

In allen erkannten Hosts installieren

bash
planu install --global

Headless-Modus für CI/CD

Verwende dieselben uneingeschränkten lokalen Befehle in CI; es ist keine kommerzielle Planu-Berechtigung erforderlich.

bash
planu validate SPEC-042
planu audit --path /pfad/zum/projekt

Vollständiger SDD-Zyklus vom Terminal aus

bash
planu init                                     # Projekt initialisieren
planu create "Zahlungsfluss hinzufügen" --type feature
planu list --status draft                      # ausstehende Specs prüfen
planu status SPEC-001 --set approved
planu validate SPEC-001                        # Abdeckung nach Implementierung prüfen
planu audit                                    # Code-Qualität bewerten

Globale Flags

Diese Flags gelten für alle Befehle.

FlagKurzBeschreibung
--help-hHilfe für den aktuellen Befehl anzeigen.
--versionInstallierte Planu-Version anzeigen.
--jsonRohausgabe als JSON (nützlich für Scripting und Pipes).
--quiet-qNicht wesentliche Ausgaben unterdrücken.
--verboseVollständige Stack Traces bei Fehlern anzeigen.
Tritt der Community beiStelle Fragen, teile Feedback und vernetze dich mit anderen Entwicklern, die Planu nutzen.
Discord beitreten