Vous avez sorti quelque chose avec v0, Bolt, Lovable ou une longue session Claude. Ça marche. Le README dit encore Getting Started with Create React App, et rien ne garde la trace de pourquoi chaque chose a été construite. vibetidy règle ces deux points, et s'arrête là.
npx vibetidy readme # génère README.md, montre le diff, demande confirmation
npx vibetidy issue-check --install-hook # relance sur les commits de fonctionnalité sans issueDeux commandes
readmescanne le dépôt (manifeste, scripts, dépendances,.env.example, points d'entrée, arborescence, README existant) et fait mettre en forme uniquement ces faits par un LLM, dans une structure fixe. Il montre un diff et attend votre accord avant d'écrire.issue-checkregarde ce qui est indexé. Un nouveau fichier source ou plus de 40 lignes ajoutées, c'est une fonctionnalité ; lockfiles, build, docs et tests ne comptent pas. Pas de numéro d'issue dans la branche ou les commits ? Il le signale, et peut créer l'issue avecghet écrire un fragment de changelog.
La règle d'ancrage
Le scanner est le produit ; le modèle ne fait que mettre en forme. Le prompt interdit d'inventer une fonctionnalité, une option, une variable d'environnement, une dépendance ou une version. Peu de faits donnent un README court et exact, pas un README long et plausible.
On peut voir exactement ce qui serait envoyé, sans clé d'API :
npx vibetidy readme --print-contextPetit, exprès
- Zéro dépendance à l'exécution.
npx vibetidytélécharge un seul paquet. - N'importe quel endpoint compatible OpenAI : OpenAI, OpenRouter, Anthropic, Groq, DeepSeek, Together, ou un Ollama / LM Studio local.
- Il prévient, il ne bloque pas. Un hook qui bloque le premier jour se fait contourner avec
--no-verifyle deuxième. Ajoutez--strictquand l'habitude est prise. - La CI tourne sur Ubuntu, macOS et Windows avec Node 20, 22 et 24.
L'histoire de ce que la CI a attrapé, et pourquoi npm a refusé le premier nom (en anglais) : My README generator isn't allowed to make things up.
Texte brut: vibetidy.md · Tous les projets