zoekt icon indicating copy to clipboard operation
zoekt copied to clipboard

How to use this project

Open m0re5ecsc4 opened this issue 1 year ago • 2 comments

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.

m0re5ecsc4 avatar May 28 '24 06:05 m0re5ecsc4

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).

jtibshirani avatar May 28 '24 15:05 jtibshirani

@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

kuutsav avatar Aug 27 '24 09:08 kuutsav

@m0re5ecsc4 I opened https://github.com/sourcegraph/zoekt/pull/905 to improve the usage examples. Let us know if you have questions still not covered there.

@kuutsav nice, those docs are really approachable! I've added a link to them from our query syntax docs (https://github.com/sourcegraph/zoekt/pull/905/commits/a94469cf5ae3281c7af1d89c84640f5bd8a6167c).

jtibshirani avatar Jan 30 '25 20:01 jtibshirani