Context
Parent epic: #24
Depends on: #25 (VitePress initialized)
Pages to create in docs/reference/
cli-options.md
Exhaustive table of all options sourced directly from github-code-search.ts:
| Option |
Type |
Required |
Default |
Description |
--org <org> |
string |
✅ |
— |
GitHub organization to search in |
--exclude-repositories <repos> |
string |
❌ |
"" |
Comma-separated repos to exclude (short or long form) |
--exclude-extracts <refs> |
string |
❌ |
"" |
Extracts to exclude (repo:path:index) |
--no-interactive |
boolean |
❌ |
false |
Disable interactive mode |
--format <format> |
markdown|json |
❌ |
markdown |
Output format |
--output-type <type> |
repo-and-matches|repo-only |
❌ |
repo-and-matches |
Output type |
--include-archived |
boolean |
❌ |
false |
Include archived repositories |
--group-by-team-prefix <prefixes> |
string |
❌ |
"" |
Team-name prefixes for grouping |
--no-cache |
boolean |
❌ |
false |
Bypass 24 h team-list cache |
keyboard-shortcuts.md
Full keymap table: ↑ ↓ ← → Space a n f r h/? Enter q/Ctrl+C.
Separate section for filter-mode bindings: Esc (cancel), Enter (confirm).
github-api-limits.md ⭐ (key page)
Hard limits of the GitHub Code Search API with official documentation references:
- Max query length: 256 characters
- Max results: 1 000 items (10 pages × 100 items/page)
- Max pagination: page 10 (GitHub hard cap for code search)
- Rate limits: 10 req/min unauthenticated · 30 req/min authenticated (code search endpoint)
- Max boolean operators: 5 AND / OR / NOT per query
NOT operator: not supported in code search (only in issue/PR search)
- Fork repositories: excluded by default — add
fork:true to include them
- Minimum query: must contain at least one non-qualifier term
- No regex: code search does not support regular expressions
- Official refs:
environment.md
| Variable |
Description |
Default |
GITHUB_TOKEN |
GitHub PAT (required) |
— |
CI |
Set to true to disable interactive mode |
false |
GITHUB_CODE_SEARCH_CACHE_DIR |
Override cache directory for team lists |
OS-dependent path |
Acceptance criteria
Context
Parent epic: #24
Depends on: #25 (VitePress initialized)
Pages to create in
docs/reference/cli-options.mdExhaustive table of all options sourced directly from
github-code-search.ts:--org <org>--exclude-repositories <repos>""--exclude-extracts <refs>""repo:path:index)--no-interactive--format <format>markdown|jsonmarkdown--output-type <type>repo-and-matches|repo-onlyrepo-and-matches--include-archived--group-by-team-prefix <prefixes>""--no-cachekeyboard-shortcuts.mdFull keymap table:
↑↓←→Spaceanfrh/?Enterq/Ctrl+C.Separate section for filter-mode bindings:
Esc(cancel),Enter(confirm).github-api-limits.md⭐ (key page)Hard limits of the GitHub Code Search API with official documentation references:
NOToperator: not supported in code search (only in issue/PR search)fork:trueto include themenvironment.mdGITHUB_TOKENCItrueto disable interactive modefalseGITHUB_CODE_SEARCH_CACHE_DIRAcceptance criteria
github-api-limits.mdincludes at least 3 links to official GitHub documentationgithub-code-search.tsexactly (including--no-cache)