index.md

<style> .markdown-body h2 { margin-top: 2em; } .markdown-body ul { list-style:none; padding-left: 1em; } .markdown-body ul li { margin: 0.5em 0; } .markdown-body ul li:before { content: ''; display: inline-block; height: 1.2em; width: 1em; background-size: contain; background-repeat: no-repeat; background-image: url(../batch_changes/file-icon.svg); margin-right: 0.5em; margin-bottom: -0.29em; } body.theme-dark .markdown-body ul li:before { filter: invert(50%); } </style>

Code intelligence

Navigate code, with definitions and references

Code intelligence provides advanced code navigation features that let developers explore source code. It displays rich metadata about functions, variables, and cross-references in the code.

★ Introduction to code intelligence 🗂 LSIF supported languages 📚 API docs for your code

Getting started

Install the browser extension
Add code intelligence to your code host and/or code review tool by installing the Sourcegraph browser extension. Demo video
Watch the code intelligence demo video to see it in action on GitHub. Try on public code
Interested in trying code intelligence out on public code? See this sample file on Sourcegraph Cloud.

Explanations

• Introduction to code intelligence
• Precise code intelligence
  • Precise code intelligence uploads
• Search-based code intelligence
• Code navigation features
  • Popover
  • Go to definition
  • Find references
  • Experimental Dependency navigation
  • Find implementations
  • Symbol search
• Writing an indexer
• Experimental Auto-indexing
• Experimental Auto-indexing inference

How-tos

• General
  • Configure data retention policies
• Language-specific guides
  • Index a Go repository
  • Index a TypeScript or JavaScript repository
  • Index a C++ repository
  • Index a Java, Scala & Kotlin repository
• Automate uploading LSIF data
  • Add LSIF to many repositories
  • Adding LSIF to CI workflows
  • Experimental Enable auto-indexing
  • Experimental Configure auto-indexing

Tutorials

• Manually index a popular Go repository
• Manually index a popular TypeScript repository

References

• Requirements
• Troubleshooting
• FAQ
• Sourcegraph recommended indexers
• Environment variables
• Experimental Auto-indexing configuration