Documentation
Understanding RepoQL
RepoQL gives your coding agent a searchable index of a repository: its files, declarations, and the relationships the language parsers can resolve.
The index lets an agent find relevant code before deciding how much source to read. It can search by meaning, inspect a function directly, follow recorded references, or use SQL to compare information across files. You work with your agent as usual; RepoQL supplies tools it can use during that work.
The index is shared context for an investigation
A RepoQL host reads the workspace and maintains its index as files change. Each supported format contributes useful structure, such as method signatures, document headings, imports, or data fields. The available detail depends on the format and analysis settings.
The host runs independently of an individual conversation. Agents connected to that host can use the same indexed material without rebuilding it for each session. How RepoQL runs explains the host, local clients, and remote access.
Find the relevant code, then read it
Suppose you want to know why a request is being rejected. Start with the behaviour you can describe. Search can identify the likely handlers and tests; a closer read can establish the conditions that cause rejection. If the repository uses unfamiliar terms, vocabulary search helps find its names first.
| What you need | Tool |
|---|---|
| Find likely locations for a behaviour | explore |
| Find the repository’s name for an idea | discover_vocabulary |
| Inspect a known file, symbol, or selection | read |
| Count, filter, or join repository data | query |
| Investigate a question and produce a cited explanation | explain |
These tools provide different kinds of evidence. Search identifies relevant material; source code shows the implementation; tests and runtime measurements help establish behaviour. A high search score or a confident explanation does not replace those checks.
Addresses make the next step precise
Every indexed source has an address. The address can select a whole project, a set of files, a symbol, or a line range. Read views let you request declarations, source, references, or git history for the same selection.
For example, file:///src/**/*.cs#symbol=*Service => structure selects matching service symbols in C# source and asks for their declarations. Learn the address grammar when you want to understand or steer an agent’s selection.
Extend what the agent can investigate
| Task | Where to start |
|---|---|
| Read a dependency or another repository | Import sources |
| Combine operations or create an artifact | Run JavaScript |
| Inspect a program’s telemetry and resource use | Watch a process |
| Keep an explanation or rule for future sessions | Understand concepts · Capture one |
| Check indexing or change settings | Manage the host |
Follow a worked approach
- Investigate an unfamiliar codebase: learn the names, locate the implementation, and verify an answer.
- Profile with watch: establish that telemetry is arriving before interpreting timings.
- Keep what you learn: turn a discovery into useful repository guidance.
Setup, data, and detailed help
The installation guide connects RepoQL to your agent. Local indexing, source reads, SQL over the local graph, and local search work without a cloud account. Cloud embeddings, reranking, and generated explanations add network processing; Your data describes what is sent and retained.
The manual included with your installed version is available at help:///. Your agent can search and read it with the same tools it uses for code, including the full schemas and command options.