Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Getting Started

This section walks through installing mq-db, indexing Markdown into a store file, and querying it from the CLI, REPL, TUI, HTTP server, or the Rust library directly.

The typical workflow is:

  1. Index one or more Markdown files into a .mq-db store file (Install, CLI).
  2. Query the store with SQL or mq, either one-shot from the CLI, interactively in the REPL / TUI, or over HTTP via mq-db serve.
  3. Optionally, embed mq-db directly with the Library API instead of shelling out to the CLI.
mq-db index docs/ --recursive --output store.mq-db
mq-db sql "SELECT block_type, count(*) FROM blocks GROUP BY block_type" --db store.mq-db