lsif-go

README

Go LSIF indexer

Visit https://lsif.dev/ to learn about LSIF.

Installation

Binary downloads are available on the releases tab.

Installation: Linux

curl -L  https://github.com/sourcegraph/lsif-go/releases/download/v1.1.3/src_linux_amd64 -o /usr/local/bin/lsif-go
chmod +x /usr/local/bin/lsif-go

Installation: MacOS

curl -L  https://github.com/sourcegraph/lsif-go/releases/download/v1.1.3/src_darwin_amd64 -o /usr/local/bin/lsif-go
chmod +x /usr/local/bin/lsif-go

Installation: Docker

docker pull sourcegraph/lsif-go:v1.1.2

Indexing your repository

After installing lsif-go onto your PATH, run the command in the root where your go.mod file is located.

$ lsif-go --verbose
✔ Loading packages... Done (742.23ms).
✔ Emitting documents... Done (63.89µs).
✔ Adding import definitions... Done (164.49µs).
✔ Indexing definitions... Done (14.99ms).
✔ Indexing references... Done (78.11ms).
✔ Linking items to definitions... Done (8.98ms).
✔ Emitting contains relations... Done (258.99µs).

Stats:
	Wall time elapsed:   845.53ms
	Packages indexed:    14
	Files indexed:       51
	Definitions indexed: 1654
	Elements emitted:    33956
	Packages traversed:  40

Use lsif-go --help for more information.

Updating your index

To keep your index up-to-date, you can add a step to your CI to generate new data when your repository changes. See our documentation on adding LSIF to your workflows.