building-github-index
/building-github-index
Generuje indeksy z progresywnym ujawnianiem dla repozytoriów GitHub jako wiedzę projektu Claude, w tym przeszukiwalne indeksy blogów technicznych i baz wiedzy oraz łączenie wielu repozytoriów w jeden indeks.
- Autor
- oaustegard ↗
- Repozytorium
- claude-skills ↗
- Licencja
- MIT
- Ostatnia zmiana repozytorium
- 25.10.2026
Ocena i bezpieczeństwo
- Pliki w paczce
- 5
- Skrypty
- 2
- Komentarze HTML
- 0
- Adresy URL w SKILL.md
- 2
Brak sygnałów. Repozytorium zmienione 25.10.2026, bez odwołań do wycofanych modeli i API.
MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.
- 2 skrypty w paczce. Przejrzyj je przed instalacją, bo Claude może je uruchomić.
Skrypty: scripts/github_index.py, scripts/pk_index.py
Co robi i kiedy
Generuje indeksy z progresywnym ujawnianiem dla repozytoriów GitHub jako wiedzę projektu Claude, w tym przeszukiwalne indeksy blogów technicznych i baz wiedzy oraz łączenie wielu repozytoriów w jeden indeks.
Wyzwalacze z opisu
Oryginalny opis (EN)
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".
Jak działa
- Quick Start
- Script Options
- Description Extraction Priority
- When Descriptions Fail
- Output Format
- API Access
- Network
- Related Skills
- Condensed Format (pkindex.py)
Podgląd SKILL.md
---
name: building-github-index
description: 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".
metadata:
version: 2.0.1
---
# 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 (links to external docs, empty readmes). In these cases:
**Manual curation recommended.** Use the tree output and domain knowledge:
```bash
# Get tree structure only (fast)
python scripts/github_index.py owner/repo --skip-fetch -o skeleton.md
# Then manually enhance descriptions based on domain knowledge
```
For code-heavy repos with embedded apps:
- Directory names encode purpose: `acc_wav_gen` → "ACC waveform generation"
- Peripheral acronyms map to functions: AFEC=ADC, MCAN=CAN, TWIHS=I2C
- Operation modes: blocking, interrupt, dma, polled
## Output Format
```markdown
# {Repo} - Content Index
**Repository:** {url}
**Branch:** `{branch}`
## Retrieval Method
{API curl commands}
---
## {Category}
| Description | Path |
|-------------|------|
| {What this covers} | `{path/file.md}` |
```
Description column leads (relevance matching), path follows (retrieval key).
## API Access
Enumerate files:
```bash
curl -sL "https://api.github.com/repos/OWNER/REPO/git/trees/BRANCH?recursive=1"
```
Fetch content:
```bash
curl -s "https://api.github.com/repos/OWNER/REPO/contents/PATH?ref=BRANCH" \
-H "Accept: application/vnd.github+json" | \
python3 -c "import sys,json,base64; print(base64.b64decode(json.load(sys.stdin)['content']).decode())"
```
## Network
Both scripts download a repo tarball (single HTTP request, no per-file rate limits) then process files locally. Allowlist: `api.github.com` (tarball redirects via this endpoint)
## Related Skills
- `accessing-github-repos` - Private repos, PAT setup, tarball download
- `tree-sitting` - Detailed code structure (methods, imports, line numbers)
## Condensed Format (pk_index.py)
For token-constrained project knowledge, use the condensed script:
```bash
python scripts/pk_index.py owner/repo -o repo_pk.md
```
Produces ~80% smaller output:
- Single line per file: `path` — description
- Symbols only (no signatures)
- 15 files max per category
- No retrieval instructions section
Ideal when adding multiple repo indexes to project knowledge.
Pliki w paczce (5)
- CHANGELOG.md 1 KB
- README.md 1 KB
- SKILL.md 4 KB
- scripts/github_index.py 13 KB
- scripts/pk_index.py 7 KB
Wersje
W bazie nie ma innych skilli o nazwie building-github-index.
Identyczna treść występuje jeszcze w 1 innych folderach na GitHubie. Tu pokazujemy jedną, najlepiej ocenioną kopię.
Migawka bazy z 13.11.2026 · wersja paczki 00acf06a6b1f (skrót SHA-256 całej paczki)
Pobrania w ostatnich 30 dniach: 0 · ranking
Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.
Podobne skille
- 100claude-skills
Prowadzi przez tworzenie Agent Skills z progresywnym ujawnianiem i dobrymi praktykami: struktura skilla i progressive disclosure. - 100ariadne-thread
Tworzy struktury projektu przyjazne agentom AI z indeksowaniem progresywnym: AGENTS.md, pliki INDEX.md modułów, nagłówki intencji plików oraz llms.txt. - 90progressive-disclosure:restructure
Przebudowuje plik CLAUDE.md lub AGENTS.md w tematyczny indeks z odniesieniami do dokumentacji projektu. - 100writing-for-agents
Pisze dokumenty i porządkuje bazy wiedzy dla agentów: skille, AGENTS.md, CLAUDE.md, indeksy notatek i reguły. - 100knowledge-index
Przebudowuje na żądanie indeks główny i indeksy typów bazy cogni-knowledge, migruje starsze wiki do układu 0.0.8 i naprawia rozjechane obszary zarządzane maszynowo. - 100skill-from-book
Tworzy skille Claude z treści książek w markdownie, dzieląc wiedzę na drobne pliki referencyjne, procedury i wytyczne zastosowań.