notabene · note this well
FR
Sur cette page

CLI

Le package npm est scopé (@z29k/notabene) ; la commande installée est simplement notabene, donc npx notabene … fonctionne tel quel dès lors que le package est une dépendance de votre repo. Sans installation locale, utilisez toujours le nom scopé — npx -y @z29k/notabene@latest … — car notabene non scopé n’est pas notre package.

CommandeCe qu’elle fait
notabene doctorÉtat en lecture seule au format JSON : config/store/port + dossiers de doc détectés — --json
notabene initÉcrit notabene.config.mjs + crée le store (sans effet s’il existe déjà) ; --detect auto-détecte les dossiers de doc. Écrit aussi le point d’entrée agent : <store>/protocol.md + un bloc borné dans AGENTS.md — désactivables via --no-protocol / --no-agents-md. Idempotent : relancez-le pour rafraîchir les deux
notabene devDémarre le serveur de revue sur les docs de ce repo (rechargement à chaud) ; --detach le lance en démon d’arrière-plan. Avec la dépendance de dev optionnelle pagefind, sa recherche devient plein texte aussi
notabene statusLe serveur détaché tourne-t-il ? (pid, port, URL) — --json
notabene stopArrête le serveur détaché
notabene buildConstruit le site (Node standalone ; docs prérendues, pas d’API d’écriture dans l’artefact)
notabene build --publicSite statique en lecture seule pour hébergement public — voir le guide. [--site URL] [--base /sub] [--out DIR]. Avec la dépendance de dev optionnelle pagefind, l’artefact gagne une recherche plein texte statique
notabene previewSert le site construit
notabene lintValide les liens inter-docs contre les routes émises par le dernier build (suggestions « did you mean » ; --json). Après build --public, attrape aussi les liens de pages publiques vers du contenu privé. Exit 1 = liens cassés, 2 = pas encore de build
notabene pdfExporte un PDF via Chromium headless (sommaire de signets + numéros de page) ; --scope doc|space:K|folder:K/P|page:K/I, --locale, --out, --chrome. Nécessite la peer dep optionnelle puppeteer (ou puppeteer-core + --chrome)
notabene migrateConvertit le store vers la disposition un-fichier-par-commentaire (estampille schemaVersion 3)
notabene comments lsListe les commentaires — --open --json --page <p> (pour agents/scripts)
notabene comments doneMarque des commentaires traités : done <id…> [--note <texte>] [--journal <entryId>]. Le statut vient de review (auto → resolved, approve → addressed) — --status force, --force agit sur un commentaire en attente (hold). Écriture atomique ; tous les autres champs préservés
notabene comments reopenRenvoie des commentaires à open : reopen <id…> [--reply <texte>] [--author <nom>] — la raison devient une réponse du thread que l’agent lira à la passe suivante (le pendant CLI du rejet sur /review)
notabene comments verifyAudite le store : statuts, liens commentaire↔journal dans les deux sens, disposition des fichiers, doublons, pages disparues. --json ; exit 1 si erreurs, 2 sans store. À lancer après une passe d’agent, ou en CI
notabene journal addAjoute une entrée de journal JSON lue depuis stdin (écriture atomique ; --json renvoie { id } pour chaîner côté agent)
notabene protocolImprime le protocole agent sur stdout — --path affiche son chemin, --write rafraîchit <store>/protocol.md

Flags globaux

FlagSignification
--root <path>Racine du repo consommateur (défaut : cwd)
--config <path>Chemin de la config (défaut : <root>/notabene.config.mjs)
--port <n>Port du serveur de dev (sinon la config port, sinon un port libre)
--detachdev uniquement : démon d’arrière-plan (géré par status/stop)
--detectinit uniquement : préremplit roots[] avec les dossiers de doc trouvés
--no-protocol / --no-agents-mdinit uniquement : ne pas écrire la copie <store>/protocol.md / le bloc AGENTS.md
--hostExpose sur le LAN — réseaux de confiance uniquement (sécurité)
--public / --site / --base / --outbuild uniquement : l’artefact de site public
Mis à jour le Modifier cette page