Documentation
How to install Quarry, point it at your folders, and ask it things. 16 pages, and the first four are the ones to read in order.
Getting started
- Introduction
What Quarry is, what it indexes, and how the app, CLI and daemon fit together.
- Install
Install Quarry on macOS or Linux, then confirm the CLI and daemon are on your path.
- Index your first folder
Run quarry index on a real folder, watch the initial scan, and confirm search works.
- Project structure
Where Quarry keeps its settings, its indexes and its logs on disk.
Configuration
- Settings file
Every key in config.toml, with defaults, and how the app and CLI share the file.
- Include and exclude rules
Narrow what gets indexed with .quarryignore files or config-level rules, gitignore-style.
- Shortcuts
Default keyboard shortcuts in the desktop app, and how to change them.
- Updates and privacy
The one network request Quarry makes, what it sends, and how to turn it off.
Querying
- Query syntax
Quoted phrases, boolean operators, field filters and wildcards, with worked examples.
- The HTTP endpoint
Answer searches over a loopback port so editors, scripts and launchers read the index the app uses.
- Saved searches
Name a query once and reuse it from the app, the CLI or the HTTP endpoint.
- Ranking
How Quarry orders search results, and the small set of signals it uses to do it.
Reference
- Command line
Every quarry subcommand, its flags and its defaults, in one reference.
- Editor plugins
Search Quarry's index from VS Code or Neovim without leaving the editor.
- Index format
The postings file, document table and snippet store that make up one index.
- Exit codes
The fixed set of exit codes every quarry subcommand returns, for scripting.