code-rag AGENTS.md

Developer instructions for Code-RAG, a command-line tool that makes source code searchable by meaning instead of only by exact words. They describe its setup, architecture, and API layer.

In plain words
What is it for?
Use them when setting up Code-RAG, explaining its design, or changing its API, search, indexing, embedding, and storage components.
Why use it?
They give coding agents the project context and conventions needed to work in Code-RAG without first piecing together how its parts fit.

Instructions file for CodexOpenCode

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.

agentmods
npx agentmods add instructions/qduc/code-rag/agents-md
Clone the repo
git clone --depth 1 https://github.com/qduc/code-rag

Made for: Codex, OpenCode.

Per session 1,347 This file is loaded in full into every session.
When invoked 1,347 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
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 $0.01347 $0.01347
Opus 5 $0.00674 $0.00674
Sonnet 5 $0.00269 $0.00269
Haiku 4.5 $0.00135 $0.00135

Measured yesterday against content hash 984bda5b5776, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

code-rag AGENTS.md 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 yesterday.

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.

AGENTS.md · 124 lines

How it starts

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

Code-RAG: Quick Start for Developers

What is Code-RAG?

Code-RAG is a CLI tool that makes codebases searchable using semantic search. It converts source code into vector embeddings, stores them in a database, and lets you query them using natural language.

Example: Instead of grepping for function names, ask "authentication logic" and find all relevant auth code.

Architecture Overview

          ┌─────────────┐
          │  CLI / MCP  │  Entry points
          └──────┬──────┘
                 │
          ┌──────▼──────┐
          │    API      │  Orchestration layer (CodeRAGAPI)
          └──────┬──────┘
                 │
    ┌────────────┼────────────┬────────────┐
    │            │            │            │
┌───▼───┐    ┌───▼───┐    ┌───▼───┐    ┌───▼───┐
│Process│    │Search │    │Manage │    │ Embed │
└───┬───┘    └───┬───┘    └───┬───┘    └───┬───┘
    │            │            │            │
┌───▼───┐    ┌───▼───┐    ┌───▼───┐    ┌───▼───┐
│Chunker│    │Rerank │    │Index  │    │Storage│
└───────┘    └───────┘    └───────┘    └───────┘

Key Design: Orchestrated Plugin architecture. The CodeRAGAPI centralizes logic, while specialized components handle chunking, indexing, search analysis, and storage.

Components

1. API Layer (src/code_rag/api.py)

  • What: The central hub for all Code-RAG operations.
  • How: Integrates embedding, database, reranking, and indexing logic. Used by both CLI and MCP.
  • Features: Session tracking, auto-generated collection names, and unified indexing flow.

2. File Processor & Chunker

  • What: Discovers source files and breaks them into logical chunks.
  • How: Uses SyntaxChunker (tree-sitter based) for code-aware splitting, falling back to line-based.
  • Output: Text chunks with rich metadata (file path, line numbers, symbol names).

3. Metadata Index (src/code_rag/index/metadata_index.py)

  • What: Tracks state of indexed files for incremental updates.
  • How: Stores mtime, size, and sha256 hashes.
  • Benefit: Only re-indexes modified files, significantly speeding up subsequent runs.

Read the full file on GitHub · 124 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. yesterday First seen · 124 lines · 1,347 tokens per session scan A 984bda5b5776

Subscribe to this mod's changes

code-rag AGENTS.md is an instructions file published in the GitHub repository qduc/code-rag (1 stars, last pushed 3mo ago), licensed MIT. It adds 1,347 tokens to every session, about $0.0067 per session on Opus 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-31.