scan-source-index

Scan source trees incrementally to generate a cacheable source-index.json.

Updated Mar 27, 2026
One-click install
npx skills add https://github.com/bs-koo/gx-pm --skill scan-source-index
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: scan-source-index
Source: https://github.com/bs-koo/gx-pm/tree/main/plugins/gx-pm/skills/scan-source-index
Command: npx skills add https://github.com/bs-koo/gx-pm --skill scan-source-index

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Scan project source trees progressively to build and cache a lightweight source-index.json, reducing token usage during analysis and preserving a clear view of the codebase.

Core Features & Use Cases

  • Incremental three-level scan: tree-level overview, header-level details, and optional deeper reads to balance detail with token budget.
  • Cache-based: reuse recent scans to speed up repeated analyses and keep context fresh.
  • Framework-aware: detect common Java/Spring/eGovFrame project structures and produce structured metadata (packages, controllers, services, entities, mappers, configs).

Quick Start

Run the scan against your local project path to generate and cache source-index.json.

Frequently Asked Questions about scan-source-index

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I incrementally scan a large codebase to reduce token usage during analysis?

Incremental scanning progressively scans source code to build a cacheable source-index.json, reducing token usage. It performs a three-level scan—tree, header, and optional detail—to balance structural analysis depth with token budgets for large codebases.

Does this source indexing tool support Java and Spring project structures?

Yes, the source indexing tool is framework-aware and supports common Java, Spring, and eGovFrame project structures. It detects these frameworks during the scan to produce structured metadata including packages, controllers, services, entities, mappers, and configs.

What is the best way to cache project structure analysis for repeated codebase reviews?

The best way to cache project structure analysis is generating a source-index.json file. This cache-based approach stores recent scan results, allowing you to speed up repeated analyses and keep project context fresh without re-reading the entire source tree.

How do I protect sensitive information and secrets when scanning source code?

To protect sensitive information when scanning source code, the incremental scan automatically masks sensitive data during processing. This ensures that secrets remain secure while building the project structure overview and caching the source index results.

Can I reuse a cached source index to speed up subsequent codebase analysis?

Yes, you can reuse a cached source-index.json to speed up subsequent codebase analysis. The cache-based mechanism preserves recent scan results, enabling quick reuse for repeated reviews without performing a full, token-heavy scan of the source tree again.