Examen interactif de markdown avec lgtm

VérifiéSûr

Lance une interface utilisateur interactive en terminal pour relire des fichiers Markdown avec des commentaires ligne par ligne (bloquant, préoccupation, question, suggestion, éloge, accusé de réception). Cela aide à effectuer des revues structurées de code ou de documents directement dans le terminal, avec exportation et support du presse-papier.

Spar Skills Guide Bot
DeveloppementDébutant
02/06/2026
Claude Code
#markdown-review#tui#code-review#commenting

Recommandé pour

Synthèse automatique

Lance une interface TUI pour examiner un fichier markdown et ajouter des commentaires ligne par ligne.

Points forts

  • Navigation interactive ligne par ligne avec touches j/k
  • Types de commentaires variés : Bloquant, Préoccupation, Question, Suggestion, Éloge, Accusé de réception
  • Mise en évidence syntaxique des blocs de code
  • Exportation des commentaires en markdown ou dans le presse-papier

Limites

  • Fonctionne uniquement avec des fichiers markdown
  • Nécessite un terminal compatible TUI
  • Dépend de l'outil externe lgtm et de bun
Quand l'utiliser

Pour effectuer une revue structurée et interactive d'un document markdown comme un plan ou une spécification.

Quand l'éviter

Pour examiner des fichiers non-markdown ou lorsqu'une revue non interactive est suffisante.

Analyse de sécurité

Sûr
Score qualité85/100

The skill runs a TUI tool via bun/bunx on a user-specified markdown file, with no destructive commands, external data exfiltration, or obfuscation. It uses tmux and third-party packages but only for intended interactive review, and does not execute arbitrary shell commands from the file content.

Aucun point d'attention détecté

Comment cette analyse est faite

Exemples

Review a markdown plan
Review the plan in plan.md using lgtm.
Review the current document
I want to review the document @CLAUDE.md line by line.
Review piped markdown content
Use lgtm to review the piped content.

name: lgtm description: Launch lgtm TUI to review a markdown file with line-by-line commenting argument-hint: <file-path> [--stdin] allowed-tools: Bash(bun run *), Bash(bunx *), Bash(tmux *), Read

Launch lgtm to review the specified markdown file or piped content.

Usage

/lgtm path/to/plan.md # Opens TUI for review (auto-spawns in tmux pane) /lgtm @CLAUDE.md # @ prefix is stripped automatically /lgtm --stdin # Review content piped from stdin

What it does

Opens an interactive TUI for reviewing markdown documents with:

  • Line-by-line navigation (j/k)
  • Comment types: Blocker, Concern, Question, Suggestion, Praise, Acknowledge
  • Syntax highlighting for code blocks
  • Export to markdown (E) or clipboard (y)
  • Summary view (v)

Instructions

When this skill is invoked, follow these steps:

  1. Parse arguments: Extract the file path from $ARGUMENTS. If it starts with @, strip that prefix. Ignore --tmux if present (it's automatic).
  2. Resolve path: Convert the file path to an absolute path if it isn't already.
  3. Read the file: Use the Read tool to load the full file content into context. This is essential so you can correlate the user's line-level comments with actual file content.
  4. Create export path: Generate /tmp/lgtm-export-{basename-without-extension}.md
  5. Run the TUI: Check if ${CLAUDE_PLUGIN_ROOT}/node_modules exists to determine the run command. The --export-on-quit flag automatically enables tmux mode and waits for the user to quit.
    • If ${CLAUDE_PLUGIN_ROOT}/node_modules exists (local dev):
      bun run ${CLAUDE_PLUGIN_ROOT}/src/cli.ts "<resolved-file-path>" --export-on-quit "<export-path>"
      
    • If node_modules does not exist (marketplace install):
      bunx @hapticdata/lgtm "<resolved-file-path>" --export-on-quit "<export-path>"
      
  6. Read the export: After the command returns (user has quit the TUI), use the Read tool to read the export file.
  7. Respond in review mode: This is a collaborative review workflow. After reading the export:
    • Correlate each comment with the corresponding line(s) from the original file content you read in step 3.
    • Summarize the user's feedback, grouping by comment type (Blockers, Concerns, Questions, Suggestions, Praise).
    • Proactively address blockers and concerns first — propose concrete code or content changes to resolve them.
    • Answer any questions the user raised.
    • Acknowledge suggestions and praise.
    • Offer to iterate on the file by applying the proposed changes.

Du fichier au premier essai

Le téléchargement contient exactement le contenu affiché sur cette fiche. Cette copie peut différer de la dernière version du dépôt source.

Consulter la source et ses fichiers annexes

Ce téléchargement contient uniquement SKILL.md. Les scripts, références, modèles et dépendances éventuels ne sont pas inclus. Récupérez les fichiers nécessaires depuis la source en conservant leur arborescence avant de poursuivre.

1. Télécharger le fichier

Télécharger SKILL.md

Depuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/interactive-markdown-review-with-lgtm-tui-mm5t8alf/SKILL.md, ou utilisez la commande suivante. Ce dossier sert à examiner la skill avant son installation.

Commande pour macOS/Linux ou WSL : un shell POSIX et curl sont nécessaires. Sous Windows sans WSL, utilisez le bouton de téléchargement et créez le dossier manuellement.

mkdir -p '.skill-downloads/interactive-markdown-review-with-lgtm-tui-mm5t8alf' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/interactive-markdown-review-with-lgtm-tui-mm5t8alf/download' --output '.skill-downloads/interactive-markdown-review-with-lgtm-tui-mm5t8alf/SKILL.md.part' && mv '.skill-downloads/interactive-markdown-review-with-lgtm-tui-mm5t8alf/SKILL.md.part' '.skill-downloads/interactive-markdown-review-with-lgtm-tui-mm5t8alf/SKILL.md'

2. Vérifier les prérequis

Lisez SKILL.md avant de l’utiliser. Si le fichier cite des scripts ou services externes, examinez-les et préparez les accès nécessaires dans votre environnement de test.

Outils déclarés par l’auteur (à vérifier dans votre agent) : Bash(bun run *), Bash(bunx *), Bash(tmux *), Read

Aucune section de prérequis reconnue dans ce fichier. Cela ne signifie pas qu’il est autonome : les bibliothèques, outils et accès peuvent être cités ailleurs dans le contenu ou dans le dépôt source.

Les plateformes de la fiche sont des indications du catalogue. Les chemins ci-dessous suivent la documentation des outils ; ils ne prouvent pas que cette skill y a été exécutée. Aucune version minimale de ces outils n’est attestée pour cette fiche.

3. Charger la skill

Après vérification, copiez le dossier complet dans le projet avec l’une des commandes ci-dessous, puis ouvrez une nouvelle session de l’outil. La commande s’arrête si un dossier du même nom existe déjà : comparez les fichiers avant de le remplacer.

Claude Code
test -f '.skill-downloads/interactive-markdown-review-with-lgtm-tui-mm5t8alf/SKILL.md' && test -s '.skill-downloads/interactive-markdown-review-with-lgtm-tui-mm5t8alf/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/lgtm' && cp -R '.skill-downloads/interactive-markdown-review-with-lgtm-tui-mm5t8alf' '.claude/skills/lgtm'

OpenSkills

OpenSkills doit déjà être installé. La procédure locale install/read est contrôlée avec OpenSkills 1.5.0, qui exige Node.js ≥ 20.6.0. Aucun slug du catalogue n’est résolu automatiquement.

Installation officielle d’OpenSkills
openskills install './.skill-downloads/interactive-markdown-review-with-lgtm-tui-mm5t8alf'

openskills read 'interactive-markdown-review-with-lgtm-tui-mm5t8alf'

La lecture doit afficher le contenu du fichier installé et son dossier de base. Elle ne lance ni la skill ni ses dépendances.

Pour un agent qui lit AGENTS.md, synchronisez ensuite l’index. Cette commande modifie AGENTS.md : relisez le diff avant de l’utiliser.

openskills sync

Mode manuel ou autre outil : joignez SKILL.md à une conversation, ou ouvrez-le dans un agent capable de lire les fichiers. Ajoutez les ressources annexes nécessaires. Il n’existe pas de dossier universel reconnu par tous les outils.

4. Faire un premier essai

Utilisez une entrée courte et fictive : un endpoint d’API, un petit document ou un brief d’interface. Dans une nouvelle conversation, joignez le fichier ou donnez son chemin à l’agent, puis adaptez cette demande :

Lis .skill-downloads/interactive-markdown-review-with-lgtm-tui-mm5t8alf/SKILL.md et applique ses instructions à cet exemple : [décrire une entrée de test]. Indique les fichiers, dépendances ou accès qui manquent. Produis le résultat demandé par la skill sans inventer de données ni exécuter de script non examiné.

Résultat attendu : une sortie correspondant aux instructions de la skill, ou une liste précise des prérequis manquants. Une simple confirmation de lecture ne valide pas le premier usage. Si une ressource externe est indisponible, ce parcours reste à tester.

Skills similaires