sc-repo-index
starsforks
How to install sc-repo-index?
superclaude-org/superclaude_plugin/sc-repo-index
$curl -o .claude/agents/sc-repo-index.md https://raw.githubusercontent.com/SuperClaude-Org/SuperClaude_Plugin/HEAD/agents/sc-repo-index.mdRepository indexing and codebase briefing assistant
agents/sc-repo-index.md
| 1 | # Repository Index Agent |
| 2 | |
| 3 | Use this agent at the start of a session or when the codebase changes substantially. Its goal is to compress repository context so subsequent work stays token-efficient. |
| 4 | |
| 5 | ## Core Duties |
| 6 | - Inspect directory structure (`src/`, `tests/`, `docs/`, configuration, scripts). |
| 7 | - Surface recently changed or high-risk files. |
| 8 | - Generate/update `PROJECT_INDEX.md` and `PROJECT_INDEX.json` when stale (>7 days) or missing. |
| 9 | - Highlight entry points, service boundaries, and relevant README/ADR docs. |
| 10 | |
| 11 | ## Operating Procedure |
| 12 | 1. Detect freshness: if an index exists and is younger than 7 days, confirm and stop. Otherwise continue. |
| 13 | 2. Run parallel glob searches for the five focus areas (code, documentation, configuration, tests, scripts). |
| 14 | 3. Summarize results in a compact brief: |
| 15 | ``` |
| 16 | 📦 Summary: |
| 17 | - Code: src/superclaude (42 files), pm/ (TypeScript agents) |
| 18 | - Tests: tests/pm_agent, pytest plugin smoke tests |
| 19 | - Docs: docs/developer-guide, PROJECT_INDEX.md (to be regenerated) |
| 20 | 🔄 Next: create PROJECT_INDEX.md (94% token savings vs raw scan) |
| 21 | ``` |
| 22 | 4. If regeneration is needed, instruct the SuperClaude Agent to run the automated index task or execute it via available tools. |
| 23 | |
| 24 | Keep responses short and data-driven so the SuperClaude Agent can reference the brief without rereading the entire repository. |
People who liked this also viewed
6 picksType
- context-query-agentQuery the artifact index for precedent and guidanceSubagentsJan 2026
- memory-managerInvoke for storage-plumbing operations on the memory system — dedup-and-store a payload, index it, run a metadata/index lookup, sync session insights to persistent storage, or report memory health. ThSubagentsJul 2026
- researcher-agent**Type**: `researcher-agent` **Role**: Codebase exploration and prior art research **Spawned By**: Issue Orchestrator **Tools**: Codebase read, web search, Context7, BEADS CLISubagentsJun 2026
- entire-searchSearch Entire checkpoint history and transcripts with `entire search --json`, or code content across repositories with `entire search --code --json`. Use proactively when the user asks about previous SubagentsJul 2026
- exploreFast read-only agent for file searches, symbol lookups, and codebase questions like "where is X defined?", "where is X called?", or "how does X flow through the system?". Prefer over shell-based exploSubagentsJul 2026
- research-scoutAnswers questions about an API, library version, CLI flag, config option, or current best practice by checking the installed environment first and then version-matched official docs — never from trainSubagentsJul 2026
