Documentation
Understanding RepoQL
RepoQL gives your agent the tools to find out how your system works and how its pieces connect, distil what it learns, and share it with your team.
You keep working with the agent you already use. RepoQL runs a host beside your code that indexes it and keeps the index current as files change. Your agent calls RepoQL’s tools when it needs to look something up.
- Understand. Find the code behind a behaviour, even when you don’t know what it’s called.
- Follow the connections. Bring in other repositories, documents, reports and telemetry, and search them the same way.
- Remember why. Save what an agent learns as a file your team reviews, so the next agent starts with it.
- Share the context. Put one host within reach of every agent on your team.
Understand
Start from the behaviour you can describe, such as why a request is rejected. Your agent searches for the code behind it, learns your repository’s names for things, then reads exactly the part it needs.
| To | Use |
|---|---|
| Find where a behaviour lives | explore |
| Find your repository’s name for an idea | discover_vocabulary |
| Read a file, a declaration or a line range | read |
| Count, filter or join what’s indexed, with SQL | query |
| Get a cited answer to a question | explain |
| Combine several steps in one script | execute |
Every tool takes an address: one string that says where to look, what to pick out and how to show it.
RepoQL parses 33 format families to declarations and structure: TypeScript, Python, Go, Rust, C++, .NET, JVM, Swift, Ruby, PHP, SQL, dbt, JSON, YAML, Markdown, HTML, Jinja, Mermaid, GraphQL, Terraform, CSS, CSV, Make, Proto, Bend, Jupyter, OpenAPI, PDF, DOCX, XLSX, images, zip archives and RQL objects. The manual in your installed version documents formats under help:///formats/. What your agent sees shows what parsing gives an agent.
Search finds the material. The code, the tests and measurements are what establish how the system behaves, so a high search score or a confident explanation doesn’t replace checking them.
Follow the connections
A change in one place can break something in another, and the answer is rarely in the code you have checked out. import brings in other repositories, local folders, S3 buckets, lint reports and test coverage. watch runs a program and records its telemetry. Everything imported answers to the same tools and addresses as your own code.
If your system runs under Aspire, one line in the AppHost sends every service’s telemetry to RepoQL. Observe, fix and optimise with Aspire follows a failure and a slow request across services, back to the code.
Remember why
When an agent learns something the next one will need, it saves it as a concept: a rule and the reason for it, in a Markdown file in your repository. RepoQL checks it against the code, shows it to agents before they edit the files it covers, and rechecks it as the code changes.
Start with Concepts, then the Keep what you learn guide.
Share the context
Not every agent runs beside a checkout: a review bot, a chat bot, a teammate asking from their phone. Uplink puts one RepoQL host, with your repositories and your team’s knowledge, within reach of all of them. The host runs on your infrastructure and connects out, so there’s no port to open.
How RepoQL runs covers the host on your own machine and sharing one with a team.
Guides
- Investigate an unfamiliar codebase: learn the names, find the implementation and check the answer.
- Profile with watch: confirm telemetry is arriving before you read the timings.
- Keep what you learn: turn a discovery into guidance the next agent can use.
Integrations
- Observe, fix and optimise with Aspire: send every service’s telemetry to RepoQL, then fix what failed and speed up what’s slow.
Setup, data and the manual
The installation guide connects RepoQL to your agent. Local indexing, source reads, SQL over the local index and local search work without a cloud account. Cloud embeddings, reranking and generated explanations send data for processing; Your data describes what is sent and what is kept.
The manual for your installed version lives at help:///. Your agent searches and reads it with the same tools it uses on code, including every schema and command option. command checks indexing and changes settings.