Quickstart
After installing, index a repository and ask it questions. Most answers come back in about a millisecond — the index is held by a background daemon, so a query never re-reads your project.
-
Index the repository
From the repository root:
Terminal window basemind scanThis walks the tree, parses with tree-sitter, and writes a content-addressed blob store + inverted index in the global cache (
~/.local/share/basemind/on Linux,~/Library/Application Support/basemind/on macOS). Takes a few seconds for small repos, around 18 seconds for an 81k-file TypeScript monorepo. -
Find where a symbol is defined
Terminal window basemind code symbols "parseQuery"Output:
src/parser.rs:142:1 parseQuery (function)src/utils.rs:89:1 parseQuery (type alias)Now you know exactly where to read — no grep noise, no manual parsing.
-
See what calls a function
Terminal window basemind code refs "processFile"Output:
src/scanner.rs:142:9 processFilesrc/scanner.rs:201:13 processFilesrc/extract.rs:57:20 processFileEvery place it’s called, with line and column numbers.
-
Find who last touched a line
Terminal window basemind git blame src/main.rsOr drill down to a single symbol:
Terminal window basemind git blame-symbol src/main.rs "processFile"Shows the last commit, author, and timestamp for each line or symbol.
-
Keep the index fresh
As you edit, update the index with:
Terminal window basemind watchThis runs in the foreground and re-indexes on file changes. Or use
basemind serveif you’re querying via the MCP server or plugin.
What to expect
Section titled “What to expect”-
Index build: Seconds for small repos; the largest test case (81k TypeScript files) scans in around 18 seconds. Re-scans are much faster — only changed files are re-indexed.
-
Query latency: about a millisecond for an outline and 1–5 ms for symbol, reference and caller lookups on a 74k-file monorepo (in-process, p50; smaller repos are faster). Git history lookups in tens of microseconds. See Performance.
-
Outline before you read: Use
code_outlineto see a file’s structure (symbols, signatures, line numbers, imports) without opening it.Terminal window basemind code outline src/parser.rsOutput shows every symbol and its line number, so you know exactly what to read.
Next steps
Section titled “Next steps”Using the plugin or MCP server
Section titled “Using the plugin or MCP server”If you’re using the plugin or MCP server instead of the CLI, you’re already
indexed once you run /bm-scan or call index_rescan. From
there, use the tools in the chat:
- Find a definition: Call
code_symbolswith aname. - Find references: Call
code_refswith aname. - Browse before reading: Call
code_outlinewith apath. - Check git history: Call
git_blamewith apathandsymbol, orgit_log(no arguments for recent commits,pathfor one file).
All the same queries, just over the MCP surface instead of the CLI.