Google Git
Sign in
gerrit / zoekt / f8e8ada171c74085dd5ac222e08e5067d1858ce4
commitf8e8ada171c74085dd5ac222e08e5067d1858ce4[log] [tgz]
authorKeegan Carruthers-Smith <keegan.csmith@gmail.com>Mon Nov 08 15:56:52 2021 +0200
committerKeegan Carruthers-Smith <keegan.csmith@gmail.com>Mon Nov 08 15:56:52 2021 +0200
treeb9ebaf7cafafd46f19d5b189beb125d50579d26c
parentf7d54faa261b31f7258a2d1291531ebd89ce8ee5 [diff]
Add notice in README pointing to sourcegraph/zoekt

Change-Id: I132d0b816c337be8ee7b1ded6087c9d6b8469efd
2 files changed
tree: b9ebaf7cafafd46f19d5b189beb125d50579d26c
  1. build/
  2. cmd/
  3. ctags/
  4. doc/
  5. gitindex/
  6. query/
  7. shards/
  8. testdata/
  9. web/
  10. .gitignore
  11. all.bash
  12. api.go
  13. bits.go
  14. bits_test.go
  15. build-deploy.sh
  16. contentprovider.go
  17. CONTRIBUTING
  18. eval.go
  19. eval_test.go
  20. go.mod
  21. go.sum
  22. hititer.go
  23. hititer_test.go
  24. index_test.go
  25. indexbuilder.go
  26. indexdata.go
  27. indexfile_other.go
  28. indexfile_unix.go
  29. LICENSE
  30. matchiter.go
  31. matchtree.go
  32. matchtree_test.go
  33. read.go
  34. read_test.go
  35. README.md
  36. section.go
  37. section_test.go
  38. toc.go
  39. write.go
README.md
"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)

NOTICE: github.com/sourcegraph/zoekt is the active main repository for Zoekt development.

INSTRUCTIONS

Downloading:

go get github.com/google/zoekt/

Indexing:

go install github.com/google/zoekt/cmd/zoekt-index
$GOPATH/bin/zoekt-index .

Searching

go install github.com/google/zoekt/cmd/zoekt
$GOPATH/bin/zoekt 'ngram f:READ'

Indexing git repositories:

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

Indexing repo repositories:

go install github.com/google/zoekt/cmd/zoekt-{repo-index,mirror-gitiles}
zoekt-mirror-gitiles -dest ~/repos/ https://gfiber.googlesource.com
zoekt-repo-index \
   -name gfiber \
   -base_url https://gfiber.googlesource.com/ \
   -manifest_repo ~/repos/gfiber.googlesource.com/manifests.git \
   -repo_cache ~/repos \
   -manifest_rev_prefix=refs/heads/ --rev_prefix= \
   master:default_unrestricted.xml

Starting the web interface

go install github.com/google/zoekt/cmd/zoekt-webserver
$GOPATH/bin/zoekt-webserver -listen :6070

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

[Unit]
Description=zoekt webserver

[Service]
ExecStart=/zoekt/bin/zoekt-webserver -index /zoekt/index -listen :443  --ssl_cert /zoekt/etc/cert.pem   --ssl_key /zoekt/etc/key.pem
Restart=always

[Install]
WantedBy=default.target

SEARCH SERVICE

Zoekt comes with a small service management program:

go install github.com/google/zoekt/cmd/zoekt-indexserver

cat << EOF > config.json
[{"GithubUser": "username"},
 {"GithubOrg": "org"},
 {"GitilesURL": "https://gerrit.googlesource.com", "Name": "zoekt" }
]
EOF

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

This will mirror all repos under ‘github.com/username’, ‘github.com/org’, 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.

SYMBOL SEARCH

It is recommended to install Universal ctags to improve ranking. See here for more information.

ACKNOWLEDGEMENTS

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

DISCLAIMER

This is not an official Google product