Cursor rule

1---
2description: Search GitHub for examples
3globs:
4alwaysApply: false
5---
6# How to Use the `ghx` CLI for GitHub Code Search
7 
8**Your task: When you need to find code examples, files, or specific patterns on GitHub, use the `ghx` command-line tool. This document provides its usage instructions and examples.**
9 
10## `ghx` Command Reference
11 
12Find examples of files, code, etc on GitHub
13 
14Usage: ghx [options]
15 
16Commands:
17  ghx config      Manage configuration settings
18  ghx [query]     Search GitHub Code                                   [default]
19 
20Positionals:
21  query  Search query                                                   [string]
22 
23Options:
24      --version       Show version number                              [boolean]
25  -h, --help          Show help                                        [boolean]
26  -p, --pipe          Output results directly to stdout                [boolean]
27  -d, --debug         Output code fence contents for testing           [boolean]
28  -L, --limit         Maximum number of results to fetch  [number] [default: 50]
29  -f, --max-filename  Maximum length of generated filenames
30                                                          [number] [default: 50]
31  -c, --context       Number of context lines around matches
32                                                          [number] [default: 20]
33  -r, --repo          Search in a specific repository (owner/repo)      [string]
34  -P, --path          Search in a specific path                         [string]
35  -l, --language      Search for files in a specific language           [string]
36  -e, --extension     Search for files with a specific extension        [string]
37  -n, --filename      Search for files with a specific name             [string]
38  -s, --size          Search for files of a specific size               [string]
39  -F, --fork          Include or exclude forked repositories           [boolean]
40 
41Examples:
42  ghx 'useState'                            Search for 'useState' across all ind
43                                            exed code on GitHub
44  ghx --repo facebook/react "useState"      Search for 'useState' in the faceboo
45                                            k/react repository
46  ghx -l typescript -e tsx "useState"       Search for 'useState' in TypeScript
47                                            files with the .tsx extension
48  ghx -n package.json "dependencies"        Search for 'dependencies' specifical
49                                            ly within package.json files
50  ghx -P src/components "Button"            Search for 'Button' within the src/c
51                                            omponents path
52  ghx -s '">10000" -l go "package main"     Search for 'package main' in Go file
53                                            s larger than 10KB
54  ghx "async function" -l typescript        Search for the exact phrase 'async f
55                                            unction' in TypeScript files
56  ghx "my search terms" --pipe > results.m  Search and pipe the results directly
57  d                                          to a markdown file
58  ghx -L 100 -c 30 "complex query"          Fetch up to 100 results with 30 line
59                                            s of context per match
60  ghx -l typescript "import test"           Search for lines containing both 'im
61                                            port' AND 'test' in TypeScript files
62  ghx -l javascript "const OR let"          Search for lines containing either '
63                                            const' OR 'let' in JavaScript files
64  ghx -l css "color NOT background-color"   Search for lines containing 'color'
65                                            BUT NOT 'background-color' in CSS fi
66                                            les
67 
68**REMEMBER: Refer to these instructions and examples when constructing `ghx` commands to perform targeted and effective GitHub code searches.**
69