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:
- Index one or more Markdown files into a
.mq-dbstore file (Install, CLI). - 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. - Optionally, embed
mq-dbdirectly 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