Agent Skills › tzachbon/smart-ralph › ralph-specum-index

ralph-specum-index

GitHub

用于为现有代码库生成可搜索的索引规范。解析用户范围后扫描代码结构，生成或更新索引文件及组件/外部规格，确保输出确定性，支持干跑模式，并在完成后提供审批选项。

plugins/ralph-specum-codex/skills/ralph-specum-index/SKILL.md tzachbon/smart-ralph

触发场景

用户明确请求使用 $ralph-specum-index 用户明确要求 Ralph Specum in Codex 生成或刷新索引制品

安装

npx skills add tzachbon/smart-ralph --skill ralph-specum-index -g -y

更多选项

非标准路径

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

不安装直接使用

npx skills use tzachbon/smart-ralph@ralph-specum-index

指定 Agent (Claude Code)

npx skills add tzachbon/smart-ralph --skill ralph-specum-index -a claude-code -g -y

安装 repo 全部 skill

npx skills add tzachbon/smart-ralph --all -g -y

预览 repo 内 skill

npx skills add tzachbon/smart-ralph --list

SKILL.md

Frontmatter

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

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.