build-index

Generate a compact INDEX.md from a documentation package's contents and lock file.

67|4|Updated Jan 21, 2026
One-click install
npx skills add https://github.com/olorehq/olore --skill build-index
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: build-index
Source: https://github.com/olorehq/olore/tree/main/.claude/skills/build-index
Command: npx skills add https://github.com/olorehq/olore --skill build-index

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the generation of a compact INDEX.md to catalog the contents of a documentation package, enabling quick retrieval and offline access.

Core Features & Use Cases

  • Tiered INDEX generation based on the contents directory, producing a lightweight, searchable manifest.
  • Reads package metadata and existing documents to assemble keyword-rich sections for fast navigation.
  • Use Case: Generate an INDEX.md for vault/packages/prisma/1.0.0 to streamline offline lookups for agents.

Quick Start

Run the /build-index <config>@<version> to generate the INDEX.md.

Frequently Asked Questions about build-index

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

FAQPage Schema
How do I auto-generate an INDEX.md for my documentation package?

To auto-generate an INDEX.md for a documentation package, run the /build-index command targeting the config and version. It reads the contents directory and olore-lock.json to write a compact, keyword-rich INDEX.md for fast retrieval.

What is an INDEX.md file and why do I need one for my docs vault?

An INDEX.md for a docs vault is a lightweight, searchable manifest that catalogs documentation contents. It is needed to enable quick offline retrieval and navigation for agents accessing the package.

Can I use build-index to create a searchable manifest for offline agent lookups?

Yes, you can use build-index to create a searchable manifest for offline agent lookups. It assembles keyword-rich sections from existing documents to streamline offline access to your documentation package contents.

Does build-index require an existing olore-lock.json file to document contents?

Yes, build-index requires an existing olore-lock.json file to document contents. It reads this lock file alongside the contents directory to assemble the tiered sections and generate the final INDEX.md manifest.

How do I generate a sectioned index from the vault packages directory?

To generate a sectioned index from the vault packages directory, run /build-index <config>@<version>. It targets the specific package contents to build a tiered, keyword-rich INDEX.md using template structures.

What's the best way to catalog a documentation package for fast retrieval?

The best way to catalog a documentation package for fast retrieval is automating INDEX.md generation. This Skill reads your package metadata and documents to produce a compact, sectioned index manifest for quick lookup.