qi: Instructions file for Claude Code

CLAUDE.md

qi CLAUDE.md is an instructions file for Claude Code from itsmostafa/qi. It costs 2,219 tokens per session, scanned A, original, MIT.

Repository instructions for qi, a local-first macOS command-line tool that searches Markdown and text documents using keyword and vector search and can answer questions with citations.

In plain words
What is it for?
Use it when changing qi, its document index, search, local embedding providers, SQLite database, or question-answering features, and when verifying changes.
Why use it?
It records the project’s build and test commands and explains important design choices such as SQLite storage, embeddings, and content deduplication.

Instructions file for Claude Code

Written for Claude Code: the file is CLAUDE.md. Also seen: mentions subagents; mentions Claude Code; mentions AGENTS.md.

This is itsmostafa/qi's own configuration. It tells Claude Code how to work on qi itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything qi configures →

Reuse

Borrowing it

Nothing to install: this file belongs to itsmostafa/qi. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/itsmostafa/qi/main/CLAUDE.md
Clone the repo
git clone --depth 1 https://github.com/itsmostafa/qi

Made for: Claude Code.

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 qi CLAUDE.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/itsmostafa/qi/claude-md/github.svg)](https://agentmods.dev/instructions/itsmostafa/qi/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/itsmostafa/qi/claude-md"><img src="https://agentmods.dev/badge/instructions/itsmostafa/qi/claude-md/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 qi CLAUDE.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/itsmostafa/qi/claude-md"><img src="https://agentmods.dev/badge/instructions/itsmostafa/qi/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 2,219 This file is loaded in full into every session.
When invoked 2,219 The same file — it is already loaded in full.
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.02219 $0.02219
Opus 5.5 $0.00888 $0.00888
Sonnet 5.5 $0.00444 $0.00444
Haiku 4.5 $0.00222 $0.00222

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

Security

Grade A, and why

qi CLAUDE.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 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.

CLAUDE.md · 100 lines

How it starts

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

qi — Agent Guidance

This file is the canonical guidance for AI coding agents working in this repo. AGENTS.md is a symlink to it, so Claude Code, Codex, and other agents read the same instructions.

Project Overview

qi is a local-first knowledge search CLI for macOS and Linux. It indexes documents (Markdown, plaintext) into a SQLite database and provides BM25 full-text search and vector search (with local embedding providers).

Working Style

  • Treat requests for action as instructions to complete the work. Do not stop at acknowledging the request, proposing a plan, or offering to continue.
  • Infer routine details from the request, repository context, and existing conventions. Make reasonable assumptions and persist until the intended outcome is complete.
  • Before asking a clarifying question, finish the work already authorized by context and make any remaining decision concrete and reviewable. Ask only when the answer could materially change the result.
  • Explicit user instructions take precedence over guidance in a skill. If a skill causes work to pause, remain unfinished, or diverge from the request, identify the exact skill instruction and explain how it applies.
  • Do not add unsolicited warnings, approval steps, or checklists for hypothetical risks.

Communication

  • State the outcome or main point early. Use concise paragraphs with one main idea each.
  • Prefer plain language and active voice. Include technical detail only when it helps the reader understand or verify the work.
  • Use lists for genuinely parallel or sequential information and avoid unnecessary nesting, tables, headings, and repeated summaries.
  • Avoid canned phrases, invented labels, and contrastive framing that introduces alternatives the user did not ask about.

Delegation

  • When the runtime and user instructions allow subagents, delegate independent work that can run in parallel and would materially save time or improve quality.
  • Keep small or tightly coupled changes with one agent. Give delegated tasks clear boundaries, review their results, and integrate them into one coherent answer.
  • Write inter-agent messages clearly because a person may read them.

Read the full file on GitHub · 100 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 · +366 tokens per session 525311fee50d
  2. 1mo ago Changed · +30 lines · +916 tokens per session 8e639b8adee2
  3. 1mo ago Changed · -31 tokens per session a00534deacd8
  4. 1mo ago First seen · 68 lines · 968 tokens per session scan A 41e23adbdabd

Subscribe to this mod's changes

qi CLAUDE.md is an instructions file published in the GitHub repository itsmostafa/qi (44 stars, last pushed 1mo ago), licensed MIT. It adds 2,219 tokens to every session, about $0.0089 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.

Related

Other instructions, from other repositories

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 9,715 tokens

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,581 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,680 tokens

deepseek-harness AGENTS.md

AGENTS.md instructions for deepseek-ai/deepseek-harness, covering agents.md, pre-stable apis and released session data, repository layout, commands and host sandbox failures.

deepseek-ai/deepseek-harness · 4,261 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,731 tokens