Fast trigram based code search

Clone this repo:


  1. 1b2a8fe Fix gitiles crawler: by Han-Wen Nienhuys · 2 days ago master
  2. a6b6559 Support CGit in the indexserver by Han-Wen Nienhuys · 2 days ago
  3. 9acb933 Document new URL type. by Han-Wen Nienhuys · 2 days ago
  4. c2306ea Support gitweb URLs by Han-Wen Nienhuys · 2 days ago
  5. e7bf432 Add --allow_missing_branches option. by Han-Wen Nienhuys · 3 days ago
"Zoekt, en gij zult spinazie eten" - Jan Eertink

("seek, and ye shall eat spinach" - My primary school teacher)

This is a fast text search engine, intended for use with source code. (Pronunciation: roughly as you would pronounce “zooked” in English)



go get


go install
$GOPATH/bin/zoekt-index .


go install
$GOPATH/bin/zoekt 'ngram f:READ'

Indexing git repositories (requires libgit2 + git2go):

go install
$GOPATH/bin/zoekt-git-index -branches master,stable-1.4 -prefix origin/ .

Indexing repo repositories (requires libgit2 + git2go):

go install{repo-index,mirror-gitiles}
zoekt-mirror-gitiles -dest ~/repos/
zoekt-repo-index \
   -name gfiber \
   -base_url \
   -manifest_repo ~/repos/ \
   -repo_cache ~/repos \
   -manifest_rev_prefix=refs/heads/ --rev_prefix= \

Starting the web interface

go install
$GOPATH/bin/zoekt-webserver -listen :6070

A more organized installation on a Linux server should use a systemd unit file, eg.

Description=zoekt webserver

ExecStart=/zoekt/bin/zoekt-webserver -index /zoekt/index -listen :443  --ssl_cert /zoekt/etc/cert.pem   --ssl_key /zoekt/etc/key.pem



Zoekt comes with a small service management program:

go install

cat << EOF > config.json
[{"GithubUser": "username"},
 {"GitilesURL": "", Name: "zoekt" }

$GOPATH/bin/zoekt-server -mirror_config config.json

This will mirror all repos under ‘’ as well as the ‘zoekt’ repository. It will index the repositories.

It takes care of fetching and indexing new data and cleaning up logfiles.

The webserver can be started from a standard service management framework, such as systemd.


It is recommended to install CTags to improve ranking:

  • Universal ctags is more up to date, but not commonly packaged for distributions. It must be compiled from source.
  • Exuberant ctags is a languishing, but commonly available through Linux distributions. It has several known vulnerabilities.

If you index untrusted code, it is strongly recommended to also install Bazel's sandbox, to avoid vulnerabilities of ctags opening up access to the indexing machine. The sandbox can be compiled as follows:

for f in namespace-sandbox.c namespace-sandbox.c process-tools.c network-tools.c \
   process-tools.h network-tools.h ; do \
  wget$f \
gcc -o namespace-sandbox -std=c99 \
   namespace-sandbox.c process-tools.c network-tools.c  -lm
cp namespace-sandbox /usr/local/bin/


Thanks to Alexander Neubeck for coming up with this idea, and helping me flesh it out.


This is not an official Google product