skills.rest
SteveGJones
SteveGJonesCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

kb-codeindex

Parse '# implements:' annotations and generate library/_code-index.md and library/_dependency-edges.md.

41|6|Updated Jul 12, 2025
Search Tags:#static-analysis#annotation#import-resolution#code-index#dependency-edges#shelf-index
One-click install
npx skills add https://github.com/SteveGJones/ai-first-sdlc-practices --skill kb-codeindex
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: kb-codeindex
Source: https://github.com/SteveGJones/ai-first-sdlc-practices/tree/main/plugins/sdlc-assured/skills/kb-codeindex
Command: npx skills add https://github.com/SteveGJones/ai-first-sdlc-practices --skill kb-codeindex

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill parses in-repo code for '# implements:' annotations and generates a shelf-index (library/_code-index.md) to enable knowledge discovery, while also extracting cross-module import edges into library/_dependency-edges.md for dependency visibility.

Core Features & Use Cases

  • Parse all '# implements:' annotations from the repository's source files.
  • Generate library/_code-index.md in shelf-index format to enable discovery by agents.
  • Extract and render code dependency edges to library/_dependency-edges.md for cross-module mapping.
  • Idempotent behavior: re-running yields identical outputs when inputs haven't changed.
  • Keeps the code index up to date after code changes.

Quick Start

Run kb-codeindex to refresh the shelf-index and dependency edges after updating '# implements:' annotations.

Frequently Asked Questions about kb-codeindex

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

FAQPage Schema
How do I generate a code index from in-code annotations?▼

To generate a code index, parse all '# implements:' annotations in your source files and emit a shelf-index as library/_code-index.md to enable knowledge discovery for your repository.

How do I extract cross-module import edges for dependency mapping?▼

Extract cross-module import edges by analyzing source code dependencies, resolving them to known modules, and writing the mapped output to library/_dependency-edges.md for clear dependency visibility.

How do I validate cited IDs against my library index?▼

Validate cited IDs by checking them against library/_ids.md, rendering the validated index with render_code_index, and performing idempotent writes to ensure consistent repository outputs.

What is the best way to keep a shelf-index up to date after code changes?▼

Keep a shelf-index up to date by re-running the parsing process after updating '# implements:' annotations, which refreshes both the code index and dependency edges with idempotent behavior.

Does static analysis of import dependencies work without external libraries?▼

Yes, static analysis of import dependencies works without external libraries by directly parsing in-repo source files to resolve cross-module edges and generate shelf-index files locally.

Related Skills

Explore More Software Engineering Skills→
SteveGJonesSteveGJones
41

kb-staleness-check

Compare knowledge base shelf-index hashes against library files to detect drift.

Community
Intermediate
SteveGJonesSteveGJones
41

kb-rebuild-indexes

Rebuild knowledge base shelf-indexes by detecting modified library files with content hashes.

Community
Intermediate
VoDaiLoczVoDaiLocz
24

lint-and-validate

Automate linting and static analysis of code in CI pipelines.

Community
Intermediate
mbwsimsmbwsims
71

discover

Detect hidden code conventions and generate evidence-backed rule suggestions.

Community
Intermediate