Aller au contenu

Référence CLI

La CLI Planu (planu) vous permet de gérer Planu depuis votre terminal — l'installer dans des outils IA, valider des specs, lancer des audits, et bien plus encore.

Démarrage rapide

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

# Ou sans installation globale
npx @planu/cli@latest <command>

Commandes

planu install

Détecte les outils IA installés (Claude Code, Cursor, Windsurf, Zed, Cline, Continue) et ajoute l'entrée MCP Planu dans leurs fichiers de configuration.

bash
planu install [--scope user|project] [--all]
FlagDescription
--scope user|projectInstaller au niveau utilisateur (global) ou projet. Demandé si omis.
--allIgnorer le menu de sélection et installer dans tous les outils détectés.
bash
# installation interactive
planu install

# installer dans tous les outils détectés au niveau utilisateur, sans interaction
planu install --scope user --all

planu doctor

Vérifie tous les chemins de configuration connus de chaque outil IA et indique si l'entrée MCP Planu est présente, absente ou corrompue.

bash
planu doctor

Exemple de sortie :

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

Trouve tous les fichiers de configuration contenant une entrée MCP Planu et la supprime après confirmation.

bash
planu uninstall [--yes]
FlagDescription
--yes / -yIgnorer la confirmation interactive (utile dans les scripts).

planu status

Met à jour le statut d'une spec (par exemple de draft à approved).

bash
planu status <specId> --set <status> [--project-id ID] [--notes "..."]
FlagDescription
--set / -sNouveau statut : draft, review, approved, implementing, done, blocked.
--notes / -nNotes de révision optionnelles associées à la transition.
--project-idID du projet. Détecté automatiquement depuis le répertoire courant si omis.
bash
planu status SPEC-042 --set approved
planu status SPEC-042 --set done --notes "Tous les critères vérifiés"

planu validate

Valide une spec par rapport à son code source — vérifie quels critères d'acceptation sont couverts et rapporte la couverture globale.

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

planu audit

Lance un audit qualité sur le projet et lui attribue un score de 0 à 100 basé sur les principes SOLID, le code propre et la conformité architecturale.

bash
planu audit [--path .] [--project-id ID] [--spec SPEC-001]
FlagDescription
--path / -pRépertoire à auditer. Par défaut : répertoire courant.
--spec / -sLimiter l'audit à une spec spécifique.
--project-idID du projet. Détecté automatiquement si omis.

planu estimate

Estime l'effort d'implémentation d'une spec — heures, complexité et décomposition des coûts.

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

planu create

Crée une nouvelle spec avec un titre et des métadonnées optionnelles.

bash
planu create <title> [--type feature] [--description "..."] [--path .]
FlagDescription
--type / -tType de spec : feature, fix, chore, spike.
--description / -dCourte description. Utilise le titre si omise.
--path / -pRépertoire du projet. Par défaut : répertoire courant.
--scopePortée de la spec.
--targetCouche ou module cible.
--featureGroupe de fonctionnalité parent.
bash
planu create "Ajouter la connexion OAuth" --type feature
planu create "Corriger le pointeur nul au checkout" --type fix --description "Pointeur nul quand le panier est vide"

planu list

Liste toutes les specs du projet courant, avec filtrage optionnel par statut ou type.

bash
planu list [--status draft] [--type feature] [--project-id ID]
FlagDescription
--status / -sFiltrer par statut : draft, review, approved, implementing, done, blocked.
--type / -tFiltrer par type : feature, fix, chore, spike.
--project-idID du projet. Détecté automatiquement si omis.
bash
planu list
planu list --status approved
planu list --type fix --status done

planu init

Initialise un répertoire comme projet Planu — analyse le stack technologique, configure la langue et crée les métadonnées du projet.

bash
planu init [path] [--locale en] [--rate 100] [--level junior|mid|senior] [--profile developer]
FlagDescription
--locale / -lLangue pour le contenu des specs : en, es, pt, fr, de, zh.
--rate / -rTaux horaire en USD pour les estimations de coût.
--levelNiveau d'expérience : junior, mid, senior.
--profileProfil utilisateur : developer, product-owner, designer, non-technical.
bash
planu init
planu init /chemin/vers/projet --locale fr --rate 75

planu serve

Démarre le serveur MCP Planu avec un transport HTTP plutôt que stdio. Utile pour les clients distants ou basés sur navigateur.

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

planu dashboard

Ouvre le tableau de bord web Planu — une interface locale dans le navigateur pour parcourir les specs, les métriques et les rapports.

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

planu watch

Surveille un répertoire de projet pour détecter les modifications de fichiers et déclenche les handlers de hooks configurés (on-save, on-create, on-delete).

bash
planu watch [path] [--hooks on-save,on-create] [--verbose] [--dry-run]
FlagDescription
--hooks / -HTypes de hooks séparés par des virgules. Par défaut : on-save,on-create,on-delete.
--verbose / -VAfficher les journaux détaillés d'exécution des hooks.
--dry-runPrévisualiser les hooks qui se déclencheraient sans les exécuter.
bash
planu watch
planu watch /chemin/vers/projet --hooks on-save --verbose
planu watch --dry-run

planu handoff

Génère un prompt de handoff structuré pour qu'un agent IA implémente une spec de manière autonome.

bash
planu handoff <specId> [--name Agent-1] [--role implementer] [--files src/a.ts,src/b.ts]
FlagDescription
--name / -nNom de l'agent. Par défaut : Agent-1.
--role / -rRôle de l'agent : implementer, reviewer, tester. Par défaut : implementer.
--files / -fListe de fichiers séparés par des virgules assignés à cet agent.
--project-idID du projet. Détecté automatiquement si omis.
bash
planu handoff SPEC-042
planu handoff SPEC-042 --name "Backend-Agent" --role implementer --files src/api/auth.ts,src/middleware/jwt.ts

Flux de travail courants

Installer dans tous les hosts détectés

bash
planu install --global

Mode headless pour CI/CD

Utilisez les mêmes commandes locales sans restriction dans le CI ; aucune autorisation commerciale Planu n'est requise.

bash
planu validate SPEC-042
planu audit --path /chemin/vers/projet

Cycle SDD complet depuis le terminal

bash
planu init                                    # initialiser le projet
planu create "Ajouter le flux de paiement" --type feature
planu list --status draft                     # examiner les specs en attente
planu status SPEC-001 --set approved
planu validate SPEC-001                       # vérifier la couverture après implémentation
planu audit                                   # évaluer la qualité du code

Flags globaux

Ces flags s'appliquent à toutes les commandes.

FlagCourtDescription
--help-hAfficher l'aide pour la commande courante.
--versionAfficher la version Planu installée.
--jsonSortie en JSON brut (utile pour les scripts et pipes).
--quiet-qSupprimer les sorties non essentielles.
--verboseInclure la trace complète de la pile sur les erreurs.
Rejoignez la communautéPosez des questions, partagez vos retours et échangez avec d'autres développeurs utilisant Planu.
Rejoindre Discord