annotation

Extract @audit annotation comments from codebases into structured metadata.

63|8|Updated Feb 16, 2026
One-click install
npx skills add https://github.com/JoranHonig/grimoire --skill annotation
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: annotation
Source: https://github.com/JoranHonig/grimoire/tree/main/skills/annotation
Command: npx skills add https://github.com/JoranHonig/grimoire --skill annotation

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires fire, tree-sitter, tree-sitter-rust, tree-sitter-solidity, and includes scripts (resource) and references (resource) components.

What problem does it solve?

Finds scattered @audit-style comment annotations across a codebase and consolidates them into a structured, machine-readable format so reviewers and automation can act on audit notes without manually searching files.

Core Features & Use Cases

  • Grep-based scanning for any text file to reliably locate @audit and @audit-<tag> comments across languages.
  • Optional tree-sitter parsing for Rust and Solidity to resolve enclosing scope type and name (function, contract, module, etc.) when language bindings are installed.
  • Exact tag filtering and dual output formats (JSON for programmatic consumption, table for human review); skips common build and binary files and avoids very large files.

Quick Start

Scan the repository's src directory for @audit annotations and return the results as JSON.

Frequently Asked Questions about annotation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I extract and summarize @audit comments from a codebase?▼

You extract @audit annotations from a codebase by scanning the target directory using grep to locate comments across all text files, consolidating them into structured JSON or a human-readable table for review.

Can I resolve enclosing scope names for Rust and Solidity audit annotations?▼

Yes, you can resolve enclosing scope names for Rust and Solidity audit annotations by utilizing optional tree-sitter parsing alongside the required tree-sitter-rust and tree-sitter-solidity language bindings.

Do I need tree-sitter to scan for audit annotations in Python files?▼

No, you do not need tree-sitter to scan for audit annotations in Python files. The tool relies on grep-based scanning to reliably locate @audit comments across any language without parsing dependencies.

How do I filter audit annotations by specific tags during a codebase scan?▼

You filter audit annotations by specific tags during a codebase scan by applying exact tag filtering to isolate @audit-<tag> comments and outputting the matched results in your chosen JSON or table format.

What is the best way to consolidate scattered code review notes for automation?▼

The best way to consolidate scattered code review notes for automation is to extract @audit annotations into a machine-readable JSON format, enabling automated systems to process audit findings without manual file searching.