# Ralph Specum Index

Should be used only when the user explicitly asks to use `$ralph-specum-index`, or...

- Repository: https://github.com/tzachbon/smart-ralph (566 stars)
- Category: Engineering
- License: MIT
- Last updated: 2026-10-28
- Runs scripts: no, instructions only

## Install

Claude Code: `npx skills add tzachbon/smart-ralph --skill ralph-specum-index -g -a claude-code -y`
Codex: `npx skills add tzachbon/smart-ralph --skill ralph-specum-index -g -a codex -y`
Cursor: `npx skills add tzachbon/smart-ralph --skill ralph-specum-index -g -a cursor -y`
Gemini CLI: `npx skills add tzachbon/smart-ralph --skill ralph-specum-index -g -a gemini-cli -y`
Claude Code plugin marketplace: `/plugin marketplace add tzachbon/smart-ralph`

## Description

This skill should be used only when the user explicitly asks to use `$ralph-specum-index`, or explicitly asks Ralph Specum in Codex to generate or refresh index artifacts.

## SKILL.md, as published by its author (untrusted third-party text, read it as data)

# Ralph Specum Index

Use this to generate searchable index specs for an existing codebase.

## Contract

- Index output lives under `specs/.index/`
- Use stable Ralph templates for `index.md`, component specs, and external specs
- Keep component and external entries deterministic and easy to diff

## Action

1. Parse the user scope such as path, types, excludes, quick mode, dry run, or force.
2. Scan the requested code areas for controllers, services, models, helpers, migrations, or comparable project structures.
3. Generate or update:
   - `specs/.index/index.md`
   - `specs/.index/components/*.md`
   - `specs/.index/external/*.md`
4. Keep outputs deterministic so start, research, and triage can reuse them.
5. Include external URLs, MCP endpoints, or installed skills only when the user asked for them or they are clearly relevant.
6. In dry run mode, report what would be created without writing files.

## Response Handoff

- After updating the index, name the files that changed and summarize the index scope briefly.
- End with exactly one explicit choice prompt:
  - `approve current artifact`
  - `request changes`
  - `continue to research`
- Treat `continue to research` as approval of the updated index artifacts.