building-github-index

Solid

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".

Code & Development 134 stars 7 forks Updated yesterday MIT

Install

View on GitHub

Quality Score: 84/100

Stars 20%
71
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Building GitHub Index Create markdown indexes of GitHub repositories optimized for Claude project knowledge. Indexes enable retrieval via GitHub API with semantic descriptions for effective matching. ## Quick Start ```bash # Documentation repos (markdown/notebooks) python scripts/github_index.py owner/repo -o index.md # Code repos (extract symbols via tree-sitter) python scripts/github_index.py owner/repo --code-symbols -o index.md # Multiple repos combined python scripts/github_index.py owner/repo1 owner/repo2 -o combined.md ``` ## Script Options | Flag | Description | |------|-------------| | `-o, --output` | Output file (default: `github_index.md`) | | `--token` | GitHub PAT; also reads `GITHUB_TOKEN` env | | `--include-patterns` | Only index matching globs: `"docs/**" "src/**"` | | `--exclude-patterns` | Skip matching globs: `"test/**"` | | `--max-files` | Cap files per repo (default: 200) | | `--skip-fetch` | Tree only, no content fetch (fast, filename-only descriptions) | | `--code-symbols` | Include code files, extract function/class names via tree-sitter | ## Description Extraction Priority 1. **YAML frontmatter** - `title:` and `description:` fields 2. **Markdown headings** - First h1/h2 as title, subsequent as topics 3. **Notebook cells** - First markdown cell heading 4. **Code symbols** - Public function/class names (with `--code-symbols`) 5. **Path-derived** - Convert filename to words (fallback) ## When Descriptions Fail Some repos have stub files (l...

Details

Author
oaustegard
Repository
oaustegard/claude-skills
Created
9 months ago
Last Updated
yesterday
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category