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
3002/06/2026
Claude Code
#markdown-review#tui#code-review#commenting

Recommandé pour

Notre avis

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é

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.
Skills similaires