building-github-index

SKILL.md

Create markdown indexes of GitHub repositories optimized for Claude project knowledge. Indexes enable retrieval of source content (.md, .qmd, .ipynb) via GitHub API without parsing rendered HTML/CSS/JS noise.

| -o, --output | Output file (default: githubindex.md) | | --token | GitHub PAT; also reads GITHUBTOKEN env var | | --include-patterns | Only index matching globs: "docs/" "blog/" | | --exclude-patterns | Skip matching globs: "test/" "drafts/" | | --max-files | Cap files per repo (default: 200) |

| --skip-fetch | Tree only, no content fetch; faster but filename-derived descriptions |

Generate progressive disclosure indexes for GitHub repositories to use as Claude project knowledge. Use when setting up projects referencing external documentation, creating searchable indexes of technical blogs or knowledge bases, combining multiple repos into one index, or when user mentions "index", "github repo", "project knowledge", or "documentation reference". Source: oaustegard/claude-skills.

View raw