Skip to content

docs: Write Reference section (CLI options, shortcuts, API limits, env vars) #28

@shouze

Description

@shouze

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:

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

  • All 4 pages exist and render without errors
  • github-api-limits.md includes at least 3 links to official GitHub documentation
  • CLI options table matches the options defined in github-code-search.ts exactly (including --no-cache)
  • No broken links

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No fields configured for Task.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions