index

index is a command for Claude Code from xerj-org/xerj. It costs 29 tokens per session (305 once invoked), scanned A, original, Apache-2.0.

A command that indexes a local folder of PDFs, office files, ebooks, notes and mail so XERJ can search it later and return source locations.

In plain words
What is it for?
Use it to prepare local documents for cited searches, and to refresh an existing index after files change.
Why use it?
It makes a folder searchable without repeatedly scanning every file, and later runs only update changed content. It also handles folders that are too large for the available disk by asking which plan to use.

Command for Claude Code

Written for Claude Code: argument-hint in frontmatter. Also seen: positional $N argument.

Part of the xerj-knowledge plugin — 1 skill, 2 commands, 1 MCP server shipped together

Good fit Use it to prepare local documents for cited searches, and to refresh an existing index after files change.

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

XERJ is a local search tool that automatically indexes folders so coding agents can retrieve relevant code, documents, logs, and PDFs without reading files one at a time. It is for developers and agents using code search, retrieval-augmented generation, security audits, or agent memory.

xerj-org/xerj · 19,064 stars · on GitHub · xerj.org

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/xerj-org/xerj

Made for: Claude Code.

Or install xerj-knowledge, the plugin that ships this one along with the rest of its 1 skill, 2 commands, 1 MCP server.

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/xerj-org/xerj/index/github.svg)](https://agentmods.dev/commands/xerj-org/xerj/index)
Your own site
<a href="https://agentmods.dev/commands/xerj-org/xerj/index"><img src="https://agentmods.dev/badge/commands/xerj-org/xerj/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/xerj-org/xerj/index"><img src="https://agentmods.dev/badge/commands/xerj-org/xerj/index.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 29 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 305 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.00029 $0.00305
Opus 5.5 $0.00012 $0.00122
Sonnet 5.5 $0.00006 $0.00061
Haiku 4.5 $0.00003 $0.00030

Measured 5d ago against content hash 7afda8546f65, 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 5d 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.

plugins/xerj-knowledge/commands/index.md · 23 lines

What it actually says

Index the folder $1 with XERJ so its documents can be searched.

  1. Choose the prefix: use $2 if it was given, otherwise a short lowercase name derived from the folder name (letters, digits and dashes only).
  2. Run xerj autoindex "$1" --prefix <prefix> and wait for it to finish. Re-runs are incremental, so this is also how to pick up changed files later. If it stops with exit code 4 and prints a JSON list of plans, the full folder would not fit the node's disk. Show the user the plans and ask which one to use before re-running with --yes (the recommended plan) or --plan <name>. Never pass --drop-indexed without asking: it confirms deleting already-indexed data.
  3. Report how many files were indexed and any files that were skipped and why, as printed by the command. Tell the user the prefix to search with: /xerj-knowledge:find <question>.

If xerj is not installed or no node is running, do not try to work around it: show the install and start steps from the plugin README.

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. 5d ago First seen · 23 lines · 29 tokens per session scan A 7afda8546f65

Subscribe to this mod's changes

index is a command published in the GitHub repository xerj-org/xerj (19,064 stars, last pushed today), licensed Apache-2.0. It adds 29 tokens to every session and 305 once invoked, about $0.0001 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-11-01.

Related

index compared with commands from other repositories

index next to 6 commands from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
indexxerj-org/xerjCommand19ktodayApache-2.0A29Claude Code
setup-vault-typesmycelium-hq/ai-brain-starterCommand50yesterdayMITA23Claude Code
slm-mediaqualixar/superlocalmemoryCommand2719d agoAGPL-3.0A101GitHub Copilot
namespaceeleboucher/meminiCommand33yesterdayAGPL-3.0A14Claude Code
doctoreleboucher/meminiCommand33yesterdayAGPL-3.0A10Claude Code
pineleboucher/meminiCommand33yesterdayAGPL-3.0A12Claude Code
remembereleboucher/meminiCommand33yesterdayAGPL-3.0A10Claude Code