Claude Cursor GitHub Copilot Skill

ralph-specum-index

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.

LLM Mart · 0 points · 17 0 0

Virus-scanned Reviewed automatically before listing.

Full trust report

Download tzachbon-smart-ralph-plugins_ralph-specum-codex_skills_ralph-specum-index-4890dd3.zip · 1 KB

tzachbon/smart-ralph 545 48 forks MIT Updated 9d ago

Part of tzachbon/smart-ralph — 44 skills

Install

skills CLI npx skills add https://github.com/tzachbon/smart-ralph/tree/main/plugins/ralph-specum-codex/skills/ralph-specum-index

Claude Code claude plugin marketplace add https://llmmart.ai/marketplace.json && claude plugin install tzachbon-smart-ralph@llmmart

Git git clone https://github.com/tzachbon/smart-ralph.git

The skills CLI installs just this skill, for any of its supported agents. Claude Code installs the whole tzachbon/smart-ralph collection as a plugin from our marketplace. Git is the plain clone.

Skill manifest

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

Parse the user scope such as path, types, excludes, quick mode, dry run, or force.
Scan the requested code areas for controllers, services, models, helpers, migrations, or comparable project structures.
Generate or update:
- specs/.index/index.md
- specs/.index/components/*.md
- specs/.index/external/*.md
Keep outputs deterministic so start, research, and triage can reuse them.
Include external URLs, MCP endpoints, or installed skills only when the user asked for them or they are clearly relevant.
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.

Files (smart-ralph)

agents

openai.yaml 316 B

interface:
  display_name: "Ralph Specum Index"
  short_description: "Index a codebase into Ralph specs"
  default_prompt: "Use $ralph-specum-index to build or refresh Ralph codebase index files, then ask me to approve the index, request changes, or continue to research."
policy:
  allow_implicit_invocation: false

SKILL.md 1.5 KB

---
name: ralph-specum-index
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.
metadata:
  surface: helper
  action: index
---

# 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.