index

index is a command for Claude Code from SuperClaude-Org/SuperClaude_Framework. It costs 12 tokens per session (735 once invoked), scanned A, original, MIT.

A command for creating and organizing documentation about a software project, including its structure, APIs, and README files.

In plain words
What is it for?
Use it to generate or maintain general project docs, API references, structure overviews, and README files in Markdown, JSON, or YAML.
Why use it?
It helps keep project knowledge findable and current, including links between related documentation and existing manual additions.

Command for Claude Code

Written for Claude Code: shipped in a Claude Code plugin. Also seen: names the TodoWrite tool.

Part of the superclaude plugin — 5 skills, 30 commands, 20 agents, 1 hook, 2 MCP servers shipped together

Good fit Use it to generate or maintain general project docs, API references, structure overviews, and README files in Markdown, JSON, or YAML.

Compare 6 commands from other repositories ↓
Install with agentmods
npx agentmods add commands/superclaude-org/superclaude_framework/index
About the project

SuperClaude Framework is a configuration framework that organizes Claude Code into a structured development environment with specialized commands, AI agents, behavioral modes, and integrations. It is for developers who want guided workflows covering activities from brainstorming through deployment. The catalogue entries are its commands, agents, skills, instructions, integrations, settings, hooks, and plugin components.

SuperClaude-Org/SuperClaude_Framework · 23,916 stars · on GitHub · superclaude.netlify.app

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Clone the repo
git clone --depth 1 https://github.com/SuperClaude-Org/SuperClaude_Framework

Made for: Claude Code.

Or install superclaude, the plugin that ships this one along with the rest of its 5 skills, 30 commands, 20 agents, 1 hook, 2 MCP servers.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for index

README.md
[![agentmods](https://agentmods.dev/badge/commands/superclaude-org/superclaude_framework/index/github.svg)](https://agentmods.dev/commands/superclaude-org/superclaude_framework/index)
Your own site
<a href="https://agentmods.dev/commands/superclaude-org/superclaude_framework/index"><img src="https://agentmods.dev/badge/commands/superclaude-org/superclaude_framework/index/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for index

Your own site · 80×15
<a href="https://agentmods.dev/commands/superclaude-org/superclaude_framework/index"><img src="https://agentmods.dev/badge/commands/superclaude-org/superclaude_framework/index.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 12 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 735 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00012 $0.00735
Opus 5.5 $0.00005 $0.00294
Sonnet 5.5 $0.00002 $0.00147
Haiku 4.5 $0.00001 $0.00073

Measured 1mo ago against content hash 1e8c71ffe490, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

index scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 1mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

Origin

Copies of this mod

1 near-identical copy found in the catalogue:

  • index — 94% identical, 10 lines differ
plugins/superclaude/commands/index.md · 88 lines

How it starts

The opening of the file, as written. The whole thing — 88 lines — stays where its author put it; the contents beside it link to each section on GitHub.

/sc:index - Project Documentation

Triggers

  • Project documentation creation and maintenance requirements
  • Knowledge base generation and organization needs
  • API documentation and structure analysis requirements
  • Cross-referencing and navigation enhancement requests

Usage

/sc:index [target] [--type docs|api|structure|readme] [--format md|json|yaml]

Behavioral Flow

  1. Analyze: Examine project structure and identify key documentation components
  2. Organize: Apply intelligent organization patterns and cross-referencing strategies
  3. Generate: Create comprehensive documentation with framework-specific patterns
  4. Validate: Ensure documentation completeness and quality standards
  5. Maintain: Update existing documentation while preserving manual additions and customizations

Key behaviors:

  • Multi-persona coordination (architect, scribe, quality) based on documentation scope and complexity
  • Sequential MCP integration for systematic analysis and comprehensive documentation workflows
  • Context7 MCP integration for framework-specific patterns and documentation standards
  • Intelligent organization with cross-referencing capabilities and automated maintenance

MCP Integration

  • Sequential MCP: Complex multi-step project analysis and systematic documentation generation
  • Context7 MCP: Framework-specific documentation patterns and established standards
  • Persona Coordination: Architect (structure), Scribe (content), Quality (validation)
  • Availability fallback: The MCP servers named here are preferred tooling, not hard requirements — when one is not installed, degrade gracefully (native reasoning in place of Sequential, official docs via web lookup in place of Context7, native tools otherwise) instead of routing work to absent servers.

Tool Coordination

  • Read/Grep/Glob: Project structure analysis and content extraction for documentation generation
  • Write: Documentation creation with intelligent organization and cross-referencing
  • TodoWrite: Progress tracking for complex multi-component documentation workflows
  • Task: Advanced delegation for large-scale documentation requiring systematic coordination

Read the full file on GitHub · 88 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 1mo ago Changed · +2 lines 1e8c71ffe490
  2. 2mo ago First seen · 86 lines · 12 tokens per session scan A 6c256a3ba519

Subscribe to this mod's changes

index is a command published in the GitHub repository SuperClaude-Org/SuperClaude_Framework (23,916 stars, last pushed 1mo ago), licensed MIT. It adds 12 tokens to every session and 735 once invoked, about $0.0000 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.