Agent skill

Ast Grep

by pproenca in pproenca/dot-skills

ast-grep rule writing and usage best practices. An agent skill from pproenca/dot-skills.

MITAuto-check passedDevelopment

Install Ast Grep

skills CLI
$ npx skills add pproenca/dot-skills --skill ast-grep -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install pproenca/dot-skills ast-grep --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/pproenca/dot-skills.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/.experimental/ast-grep .claude/skills/ast-grep && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
ast-grep
GitHub stars
214
Token cost
~2.3k tokens
SKILL.md length
708 words
Files
52 (incl. references, assets)
Skills in repo
182
Repo updated
First seen
Licence
MIT

At a glance

ast-grep rule writing and usage best practices. An agent skill from pproenca/dot-skills.

  • Works in 12 steps: Understand the Query → Create Example Code → Write the ast-grep Rule → …
  • Tasks involving YAML rules
  • SKILL.md covers When to Apply, General Workflow, Rule Categories by Priority and Quick Reference, plus 3 more sections
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Ast Grep is an agent skill from pproenca/dot-skills. ast-grep rule writing and usage best practices. This skill should be used when writing, reviewing, or debugging ast-grep rules for code search, linting, and transformation. Triggers on tasks involving YAML rules, pattern syntax, meta variables, constraints, or code rewriting.

Its SKILL.md is about 2.3k tokens, which your agent loads only when the skill is triggered. The skill folder holds 54 other files, including reference files and assets (for example `AGENTS.md`, `README.md` and `assets/templates/_template.md`).

It sits in Development, covering Linting and formatting, Codebase onboarding and Debugging. The repository describes itself as: A collection of AI agent skills following the Agent Skills open format. The licence is MIT.

When your agent uses it

  • Tasks involving YAML rules
  • Tasks that involve Linting and formatting
  • Tasks that involve Codebase onboarding

Example prompts

  • “/ast-grep”

Workflow steps

12 steps, taken from the step headings in SKILL.md.

  1. Understand the Query
  2. Create Example Code
  3. Write the ast-grep Rule
  4. Test the Rule
  5. Search the Codebase
  6. Pattern Correctness (CRITICAL)
  7. Meta Variable Usage (CRITICAL)
  8. Rule Composition (HIGH)
  9. Constraint Design (HIGH)
  10. Rewrite Correctness (MEDIUM-HIGH)
  11. Project Organization (MEDIUM)
  12. Performance Optimization (MEDIUM)

What it can do on your machine

Read from SKILL.md and the folder at commit cf93c57. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md (its code samples are bash).

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    Links to these hosts (documentation or services it may open):

    • ast-grep.github.io

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Ast Grep loads about 2.3k tokens when it runs, and up to ~19k if it reads all its reference files. Until then it costs about 71 tokens; SKILL.md has 708 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~71
When it runs · the whole SKILL.md, loaded when a task matches
~2.3k
With references · SKILL.md plus every file in references/, read only if the agent opens them
~19k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from pproenca/dot-skills at commit cf93c57, republished under its MIT licence (© pproenca). 708 words, ~2,322 tokens.

Download SKILL.mdSave it as .claude/skills/ast-grep/SKILL.md (or your agent's skills folder). This skill also uses 51 other files; get the full folder from GitHub.
name
ast-grep
description
ast-grep rule writing and usage best practices. This skill should be used when writing, reviewing, or debugging ast-grep rules for code search, linting, and transformation. Triggers on tasks involving YAML rules, pattern syntax, meta variables, constraints, or code rewriting.

ast-grep Community Best Practices

Comprehensive best practices guide for ast-grep rule writing and usage, maintained by the ast-grep community. Contains 46 rules across 8 categories, prioritized by impact to guide automated rule generation and code transformation.

When to Apply

Reference these guidelines when:

  • Writing new ast-grep rules for linting or search
  • Debugging patterns that don't match expected code
  • Optimizing rule performance for large codebases
  • Setting up ast-grep projects with proper organization
  • Reviewing ast-grep rules for correctness and maintainability

General Workflow

Follow this workflow when creating ast-grep rules for code search:

Step 1: Understand the Query

Clarify what you want to find:

  • Target programming language
  • Edge cases to handle
  • What to include vs exclude
Step 2: Create Example Code

Write a sample code snippet representing the desired match pattern.

Step 3: Write the ast-grep Rule

Choose the right approach:

  • Use pattern for simple structures
  • Use kind with has/inside for complex structures
  • Combine with all, any, or not for compound queries
  • Always use stopBy: end for relational rules (inside, has) to ensure complete search
Step 4: Test the Rule
bash
# Inspect AST structure
ast-grep run --pattern '[code]' --lang [language] --debug-query=ast

# Test inline rule
echo "[code]" | ast-grep scan --inline-rules "[rule]" --stdin

# Test from file
ast-grep scan --rule [file.yml] [path]
Step 5: Search the Codebase

Deploy the validated rule:

bash
# Search with pattern (simple matches)
ast-grep run --pattern '[pattern]' --lang [language] [path]

# Search with rule file (complex queries)
ast-grep scan --rule [file.yml] [path]

# Apply fixes interactively
ast-grep scan --rule [file.yml] --interactive [path]
Quick Tips
  1. Always use stopBy: end - Ensures complete subtree traversal for relational rules
  2. Start simple, add complexity - Begin with patterns, progress to kinds, then relational rules
  3. Debug with AST inspection - Use --debug-query=ast to verify structure matching
  4. Escape in inline rules - Use \$VAR or single quotes for shell commands
  5. Test in playground first - Use https://ast-grep.github.io/playground.html for rapid iteration

Rule Categories by Priority

PriorityCategoryImpactPrefix
1Pattern CorrectnessCRITICALpattern-
2Meta Variable UsageCRITICALmeta-
3Rule CompositionHIGHcompose-
4Constraint DesignHIGHconst-
5Rewrite CorrectnessMEDIUM-HIGHrewrite-
6Project OrganizationMEDIUMorg-
7Performance OptimizationMEDIUMperf-
8Testing & DebuggingLOW-MEDIUMtest-

Quick Reference

1. Pattern Correctness (CRITICAL)
2. Meta Variable Usage (CRITICAL)
Show full SKILL.md (294 more words)Show less
3. Rule Composition (HIGH)
4. Constraint Design (HIGH)
5. Rewrite Correctness (MEDIUM-HIGH)
6. Project Organization (MEDIUM)
7. Performance Optimization (MEDIUM)
8. Testing & Debugging (LOW-MEDIUM)

How to Use

Read individual reference files for detailed explanations and code examples:

Full Compiled Document

  • AGENTS.md - Complete compiled guide with all rules

Reference Files

FileDescription
AGENTS.mdComplete compiled guide with all rules
references/_sections.mdCategory definitions and ordering
assets/templates/_template.mdTemplate for new rules
metadata.jsonVersion and reference information

© pproenca, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 51 other files (references, assets) in skills/.experimental/ast-grep of pproenca/dot-skills.

  • SKILL.md
  • AGENTS.md
  • README.md
  • assets/templates/_template.md
  • metadata.json
  • references/_sections.md
  • references/compose-all-for-and-logic.md
  • references/compose-any-for-or-logic.md
  • references/compose-field-targeting.md
  • references/compose-has-for-children.md
  • references/compose-inside-for-context.md
  • references/compose-matches-for-reuse.md
  • references/compose-not-for-exclusion.md
  • references/compose-precedes-follows.md
  • references/const-kind-filter.md
  • references/const-not-inside-not.md
  • references/const-pattern-constraint.md
  • references/const-post-match-timing.md
  • … and 34 more

Open the folder on GitHubat commit cf93c57

Compare with similar skills

Ast Grep next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Ast Grep compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Ast Grep this skillpproenca/dot-skills214—~2.3kAutomated safety check: PassMIT
Adk Setupgoogle/adk-python22k—~993Automated safety check: NotesApache-2.0
Octocode Code Researchbgauryy/octocode946—~1.5kAutomated safety check: PassMIT
MSBuildLocator .NET Core Loadermicrosoft/MSBuildLocator263—~1.1kAutomated safety check: PassCustom licence
React Render Types SetupHorusGoul/eslint-plugin-react-render-types111—~1.8kAutomated safety check: PassMIT
cmux Contributor Dev Workflowdisler/learning-cmux-with-agents115—~1.5kAutomated safety check: PassMIT

Similar skills

  • Adk Setup

    google/adk-python

    Official

    Sets up a local ADK Python development environment in a git clone of the open-source adk-python repository: a uv virtual environment, all dependency extras, pre-commit hooks, and a first unit-test…

    22k GitHub stars~993 tokensUpdated today
    DevelopmentAuto-check: notes
  • Octocode Code Research

    bgauryy/octocode

    Researches code with evidence: traces callers, imports and cross-repo links, diagnoses failures and reports findings with exact file and line references and a confidence label.

    946 GitHub stars~1.5k tokensUpdated 4 days ago
    DevelopmentAuto-check passed
  • MSBuildLocator .NET Core Loader

    microsoft/MSBuildLocator

    Official

    Reference for how MSBuildLocator loads MSBuild assemblies and finds the .NET SDK on .NET Core hosts, for anyone editing or debugging that loader code.

    263 GitHub stars~1.1k tokensUpdated yesterday
    DevelopmentAuto-check passed
  • React Render Types Setup

    HorusGoul/eslint-plugin-react-render-types

    Install and configure eslint-plugin-react-render-types in a TypeScript React project.

    111 GitHub stars~1.8k tokensUpdated 2 mo ago
    DevelopmentAuto-check passed
  • cmux Contributor Dev Workflow

    disler/learning-cmux-with-agents

    Contributor rules for the cmux repo: tagged Debug builds through reload.sh, first-time setup, Xcode project normalization and per-tag sidebar extension points.

    115 GitHub stars~1.5k tokensUpdated 3 mo ago
    DevelopmentAuto-check passed
  • Burla Internals Deep Dive

    Burla-Cloud/burla

    Reference for Burla internals: how a remote_parallel_map job flows between services, how clusters and nodes are managed, and where the head keeps its state.

    263 GitHub stars~2.4k tokensUpdated 15 days ago
    DevelopmentAuto-check passed

More from pproenca/dot-skills

All 182 skills in this repo
  • Audio Voice Recovery

    pproenca/dot-skills

    Audio forensics and voice recovery guidelines for CSI-level audio analysis.

    214 GitHub stars~3.3k tokensUpdated 1 mo ago
    Auto-check passed
  • Codemod React Pipeline

    pproenca/dot-skills

    Guided, scripted pipeline for running JSX/TSX/React codemods safely across large legacy codebases.

    214 GitHub stars~1.6k tokensUpdated 1 mo ago
    Auto-check passed
  • Dev Rfc

    pproenca/dot-skills

    Create well-structured RFCs and technical proposals for software projects.

    214 GitHub stars~3.8k tokensUpdated 1 mo ago
    Auto-check passed
  • Dx Harness

    pproenca/dot-skills

    Developer-experience friction auditing and fixing — slow onboarding, repeated manual setup steps, missing bootstrap/reset/seed scripts, undiscoverable conventions.

    214 GitHub stars~1.5k tokensUpdated 1 mo ago
    Auto-check passed
  • Language Spec Author

    pproenca/dot-skills

    Turn a rough idea for a language into a complete, implementable specification — a DSL, query, config/data, template, or protocol language — by interviewing the author dimension by dimension until…

    214 GitHub stars~2.4k tokensUpdated 1 mo ago
    Auto-check passed
  • Python Pep Author

    pproenca/dot-skills

    Drafting Python Enhancement Proposals (PEPs) — proposing a Python language feature, a standard library change, an interoperability standard, or an informational/process document for the Python…

    214 GitHub stars~2.1k tokensUpdated 1 mo ago
    Auto-check passed

Categories

Questions about Ast Grep

What does Ast Grep do?

ast-grep rule writing and usage best practices. An agent skill from pproenca/dot-skills. Ast Grep is an agent skill from pproenca/dot-skills. ast-grep rule writing and usage best practices.

When should I use Ast Grep?

Ast Grep fits situations like: tasks involving YAML rules; tasks that involve Linting and formatting; tasks that involve Codebase onboarding.

How do I install Ast Grep in Claude Code?

Run `npx skills add pproenca/dot-skills --skill ast-grep -a claude-code`. Or copy the skill folder (skills/.experimental/ast-grep in pproenca/dot-skills) into .claude/skills/ast-grep in your project. Claude Code loads it when a task matches its description.

How do I install Ast Grep in Codex?

Run `npx skills add pproenca/dot-skills --skill ast-grep -a codex`. Or copy the skill folder (skills/.experimental/ast-grep in pproenca/dot-skills) into .agents/skills/ast-grep in your project. Codex loads it when a task matches its description.

Can I use Ast Grep in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add pproenca/dot-skills --skill ast-grep -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/ast-grep, .gemini/skills/ast-grep, .github/skills/ast-grep and .opencode/skills/ast-grep in your project.

What does Ast Grep need to run?

SKILL.md names no scripts, command-line tools or credentials: Ast Grep is instructions for the agent only.

Does Ast Grep access the network?

SKILL.md names 1 domain. As links in the text: ast-grep.github.io. This is read from the text; nothing was executed.

Is Ast Grep safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Ast Grep use?

Ast Grep is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Ast Grep use?

About 2.3k tokens (SKILL.md is roughly 9.3k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 17k tokens, read only when the agent opens those files.

What are the alternatives to Ast Grep?

Skills that share tags, products or a category with Ast Grep: Adk Setup (google/adk-python, 22k stars), Octocode Code Research (bgauryy/octocode, 946 stars), MSBuildLocator .NET Core Loader (microsoft/MSBuildLocator, 263 stars) and React Render Types Setup (HorusGoul/eslint-plugin-react-render-types, 111 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Ast Grep?

pproenca (a GitHub user) maintains it in pproenca/dot-skills, which has 214 GitHub stars. The repository holds 182 skills in this directory. The repository was last updated on August 15, 2026.

Source: pproenca/dot-skills on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.