sourcegraph / zoekt

Fast trigram based code search
Apache License 2.0
593 stars 79 forks source link

How to use this project #784

Open m0re5ecsc4 opened 3 months ago

m0re5ecsc4 commented 3 months ago

The readme of this project has not been updated for a long time. I am new to this project. How should I run it? I can only know by looking at the code. Please update the usage documentation.

jtibshirani commented 3 months ago

I agree, we should really update the README! I've added it to our queue.

In the meantime, these usage commands might be helpful: https://github.com/sourcegraph/sourcegraph/blob/462ba3de0bf4fdebfa0ed46f5ee0de3b6182634a/doc/dev/how-to/zoekt_local_dev.md#notes. (These are developer docs from the sourcegraph/sourcegraph repo).

kuutsav commented 3 weeks ago

@m0re5ecsc4 the doc folder has examples for indexing a project, for querying you can look at this project https://neogrok-demo-web.fly.dev/ which builds a ui interface on top of zoekt, they have a nice page on querying https://neogrok-demo-web.fly.dev/syntax