https://github.com/aider-ai/grep-ast
Grep source code and see useful code context about matching lines
https://github.com/aider-ai/grep-ast
Last synced: 4 months ago
JSON representation
Grep source code and see useful code context about matching lines
- Host: GitHub
- URL: https://github.com/aider-ai/grep-ast
- Owner: Aider-AI
- License: apache-2.0
- Created: 2023-07-28T21:44:46.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-05-08T01:07:19.000Z (about 1 year ago)
- Last Synced: 2025-09-28T03:30:24.923Z (10 months ago)
- Language: Python
- Size: 146 KB
- Stars: 276
- Watchers: 6
- Forks: 39
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# grep-ast
Grep source code files and see matching lines with
useful context that show how they fit into the code.
See the loops, functions, methods, classes, etc
that contain all the matching lines.
Get a sense of what's inside a matched class or function definition.
You see relevant code from every layer of the
abstract syntax tree, above and below the matches.
By default, grep-AST recurses the current directory to search all source code files.
It respects `.gitignore`, so it will usually "do the right thing" in most repos
if you just do `grep-ast ` without specifying any filenames.
You can also invoke `grep-ast` as `gast` for convenience.
Grep-AST is built with [tree-sitter](https://tree-sitter.github.io/tree-sitter/) and
[tree-sitter-languages](https://github.com/grantjenks/py-tree-sitter-languages).
So it supports a lot of popular [code languages](https://github.com/paul-gauthier/grep-ast/blob/main/grep_ast/parsers.py).
## Install
```bash
python -m pip install git+https://github.com/paul-gauthier/grep-ast.git
```
## Usage
Basic usage:
```bash
grep-ast [pattern] [filenames...]
```
Full options list:
```
usage: grep_ast.py [-h] [-i] [--color] [--no-color] [--encoding ENCODING] [--languages] [--verbose]
[pat] [filenames ...]
positional arguments:
pat the pattern to search for
filenames the files to display
options:
-h, --help show this help message and exit
-i, --ignore-case ignore case distinctions
--color force color printing
--no-color disable color printing
--encoding ENCODING file encoding
--languages print the parsers table
--verbose enable verbose output
```
## Examples
Here we search for **"encoding"** in the source to this tool.
These results mainly highlight how `grep-ast`
shows you how the matches fit into the code base.
Here we search for **"TreeContext"** in the source to this tool.
These results mainly highlight how `grep-ast`
helps you understand the *contents* of a matching
named code block (class, function, method, etc).
