2020-06-17 08:08:42 -04:00
---
2020-07-28 14:09:36 -04:00
stage: Create
2021-02-22 01:10:57 -05:00
group: Code Review
2020-11-26 01:09:20 -05:00
info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments"
2020-06-17 08:08:42 -04:00
type: reference
---
2021-02-09 13:09:59 -05:00
# Code Intelligence **(FREE)**
2020-06-17 08:08:42 -04:00
> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/1576) in GitLab 13.1.
Code Intelligence adds code navigation features common to interactive
development environments (IDE), including:
- Type signatures and symbol documentation.
2020-07-28 14:09:36 -04:00
- Go-to definition.
2020-06-17 08:08:42 -04:00
Code Intelligence is built into GitLab and powered by [LSIF ](https://lsif.dev/ )
(Language Server Index Format), a file format for precomputed code
intelligence data.
2021-02-17 13:09:19 -05:00
NOTE:
You can automate this feature in your applications by using [Auto DevOps ](../../topics/autodevops/index.md ).
2020-06-17 08:08:42 -04:00
## Configuration
Enable code intelligence for a project by adding a GitLab CI/CD job to the project's
2021-03-08 10:08:54 -05:00
`.gitlab-ci.yml` which generates the LSIF artifact:
2020-06-17 08:08:42 -04:00
```yaml
code_navigation:
2020-09-03 05:08:20 -04:00
image: sourcegraph/lsif-go:v1
2020-06-30 11:08:48 -04:00
allow_failure: true # recommended
2020-06-17 08:08:42 -04:00
script:
- lsif-go
2020-06-30 11:08:48 -04:00
artifacts:
reports:
lsif: dump.lsif
2020-06-17 08:08:42 -04:00
```
2020-11-08 22:09:03 -05:00
The generated LSIF file size may be limited by
the [artifact application limits (`ci_max_artifact_size_lsif`) ](../../administration/instance_limits.md#maximum-file-size-per-type-of-artifact ),
default to 100MB (configurable by an instance administrator).
2020-06-17 08:08:42 -04:00
After the job succeeds, code intelligence data can be viewed while browsing the code:
2020-09-04 08:08:27 -04:00
2020-06-17 08:08:42 -04:00
2020-08-14 08:10:01 -04:00
## Find references
2022-04-04 17:08:45 -04:00
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/217392) in GitLab 13.2 [with a flag](../../administration/feature_flags.md) named `code_navigation_references`. Disabled by default.
> - [Enabled on GitLab.com and self-managed](https://gitlab.com/gitlab-org/gitlab/-/issues/225621) in GitLab 13.3. Feature flag `code_navigation_references` removed.
2020-08-14 08:10:01 -04:00
To find where a particular object is being used, you can see links to specific lines of code
under the **References** tab:
2020-06-17 08:08:42 -04:00
## Language support
Generating an LSIF file requires a language server indexer implementation for the
relevant language.
| Language | Implementation |
|---|---|
2020-10-16 14:09:04 -04:00
| Go | [`sourcegraph/lsif-go` ](https://github.com/sourcegraph/lsif-go ) |
| JavaScript | [`sourcegraph/lsif-node` ](https://github.com/sourcegraph/lsif-node ) |
| TypeScript | [`sourcegraph/lsif-node` ](https://github.com/sourcegraph/lsif-node ) |
2020-06-17 08:08:42 -04:00
View a complete list of [available LSIF indexers ](https://lsif.dev/#implementations-server ) on their website and
refer to their documentation to see how to generate an LSIF file for your specific language.
