One-click install
npx skills add https://github.com/zfedoran/rsmap --skill rsmap
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: rsmap
Source: https://github.com/zfedoran/rsmap/tree/main
Command: npx skills add https://github.com/zfedoran/rsmap --skill rsmap

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you understand a Rust project without expensive full-source scanning by using precomputed, multi-layer indexes designed for LLM discovery and navigation.

Core Features & Use Cases

  • Layered codebase indexes: Generate overview.md, api-surface.md, relationships.md, and index.json to support progressively deeper understanding.
  • Fast location to source: Use index.json to map fully-qualified item paths to file locations and line ranges for targeted reading.
  • Annotation workflow for LLM descriptions: Export stale/unannotated items to TOML, fill notes externally, then import them back and regenerate the layers with descriptions.
  • Incremental rebuilds: Use cache.json and hashes to avoid unnecessary re-parsing while still updating annotations staleness.

Quick Start

Ask the AI to run rsmap generate with your Rust project path and an output directory to produce the layered index files.

Frequently Asked Questions about rsmap

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

FAQPage Schema
How do I map Rust codebase architecture for LLM semantic search without scanning the full source?

Mapping Rust codebase architecture for LLM semantic search involves generating precomputed, multi-layer indexes. This produces overview, API surface, and relationship files that enable efficient discovery without full-source scanning.

What is the best way to discover API surface and module relationships in a Rust project?

The best way to discover API surface and module relationships in a Rust project is by generating layered index files like api-surface.md and relationships.md. These provide progressively deeper understanding of crates, modules, and item signatures.

How do I locate exact source file locations and line ranges for Rust items using an LLM?

You locate exact source file locations and line ranges for Rust items using the generated index.json file. It maps fully-qualified item paths to specific file locations and line ranges for targeted reading by an LLM.

Can I add custom LLM descriptions to indexed Rust items and track their staleness?

You can add custom LLM descriptions to indexed Rust items and track staleness by exporting unannotated items to annotations.toml. Fill in notes externally, import them back, and use cache.json with hashes to track staleness during incremental rebuilds.

Does generating Rust codebase indexes for LLMs require incremental rebuilds every time?

Generating Rust codebase indexes for LLMs does not require full rebuilds every time. The process supports incremental rebuilds using cache.json and hashes to avoid unnecessary re-parsing while still updating annotation staleness.