We are working on creating guides for each language with an LSIF indexer, so make sure to check for the documentation for your language! If there is not a guide for your language, this general guide will help you through the LSIF setup process.
We’ll walk you through installing and generating LSIF data locally on your machine, and then manually uploading the LSIF data to your Sourcegraph instance for your repository. This will let you experiment with the process locally, and test your generated LSIF data on your repository before changing your CI process.
Install the Sourcegraph CLI (
src) - used for uploading LSIF data to your Sourcegraph instance. This will work in a jiffy (replace
darwin for macOS):
curl -L https://sourcegraph.com/.api/src-cli/src_linux_amd64 -o /usr/local/bin/src chmod +x /usr/local/bin/src
Install the LSIF indexer for your repository’s language:
An LSIF indexer is a command line tool that analyzes your project’s source code and generates a file in LSIF format containing all the definitions, references, and hover documentation in your project. That LSIF file is later uploaded to Sourcegraph to provide code intelligence.
You now need to generate the LSIF data for your repository. Each language’s LSIF is unique to that language, so run the command in the generate LSIF data step found in the README of the installed indexer.
For all languages, the upload step is the same. Make sure the current working directory is somewhere inside your repository, then use the Sourcegraph CLI to run:
# for private instances $ src -endpoint=<your sourcegraph endpoint> lsif upload -file=<LSIF file (e.g. dump.lsif)> # to upload to Sourcegraph.com $ src lsif upload -github-token=<your github token> -file=<LSIF file (e.g. dump.lsif)>
The upload command in the Sourcegraph CLI will try to infer the repository and git commit by invoking git commands on your local clone. If git is not installed, is older than version 2.7.0, or you are running on code outside of a git clone, you will need to also specify the
-commit flags explicitly.
If successful, you’ll see the following message:
Repository: <location of repository> Commit: <40-character commit associated with this LSIF upload> File: <LSIF data file> Root: <subdirectory in the repository where this LSIF dump was generated> LSIF dump successfully uploaded for processing. View processing status at <link to your Sourcegraph instance LSIF status>.
Possible upload errors include:
-endpointand make sure you can view the repository on your Sourcegraph instance
true(401 for an invalid token or 404 if the repository cannot be found on GitHub.com): make sure your GitHub token is valid and that the repository is correct
LSIF processing failures for a repository are listed in Repository settings > Code intelligence > Activity for this repository. Failures can occur if the LSIF data is invalid (e.g., malformed indexer output), or problems were encountered during processing (e.g., system-level bug, flaky connections, etc). Try again or file an issue if the problem persists.
Make sure you have enabled LSIF code intelligence on your Sourcegraph instance.
Once the LSIF data is uploaded, navigate to a code file for the targeted language in the repository (or sub-directory) the LSIF index was generated from. LSIF data should now be the source of hover-tooltips, definitions, and references for that file.
To verify that LSIF is correctly enabled, hover over a symbol and ensure that its hover text is not decorated with a tooltip. This icon indicates the results are from search-based basic code intelligence and should be absent when results are precise.
Now that you’re happy with the code intelligence on your repository, you need to make sure that is stays up to date with your repository. Our continuous integration guide will get you started.