Home

Spelunk is a VS Code extension with one search box for your whole workspace: file names, code, definitions and Git history, across every repo you have open. Results update as you type, and everything is indexed and searched on your machine.

What you can ask it

Question	Query
Where is RetryPolicy defined?	symbol:RetryPolicy
Who introduced retry_policy?	type:added retry_policy
What did Jane change in the tests?	author:jane is:test
Where was retry_after used in the v1.0.0 release?	at:v1.0.0 retry_after
Every call of backoff, however it's laid out	struct:"backoff(:[call], tries=:[n])"

More on Recipes, and how it compares with the searches you already have on Why Spelunk.

Where to go

I want to…	Start with
Try it	Getting Started: install, first run and your first searches
Look something up	Query Language: every operator on one screen, each linked to its full card
Fix a query or a surprise	[[Error index
Understand how it works	Architecture Overview: three processes, and what happens on each keystroke
Change it	Contributing: set up, make a change, pass the presubmit, keep the wiki in sync

flowchart LR
  WV["Webview<br/><small>search panel</small>"] -- postMessage --> EH["Extension host<br/><small>VS Code glue</small>"]
  EH -- "JSON-RPC over stdio" --> D["Search daemon (Go)<br/><small>parse · plan · search · index</small>"]
  D --> IX[("Index on disk")]

Loading

In the repo

• README and CHANGELOG
• Implementation plan: the full original design
• Progress: what each milestone delivered