SCIP (pronunciation: "skip") is a language-agnostic protocol for indexing source code, which can be used to power code navigation functionality such as Go to definition, Find references, and Find implementations.
This repository includes:
- A Protobuf schema for SCIP.
- Rich Go and Rust bindings for SCIP: These include many utility functions to help build tooling on top of SCIP.
- Auto-generated bindings for TypeScript and Haskell.
- The
scipCLI, which makes SCIP indexes a breeze to work with.
If you're interested in better understanding the motivation behind SCIP, check out the announcement blog post and the design doc.
If you're interested in writing a new indexer that emits SCIP, check out our documentation on how to write an indexer. Also, check out the Debugging section in the Development docs.
If you're interested in consuming SCIP data, you can either use one of the provided language bindings, or generate code for the SCIP Protobuf schema using the Protobuf toolchain for your language ecosystem. Also, check out the Debugging section in the Development docs.
Several indexers currently emit SCIP data:
- scip-java: Java, Scala, Kotlin
- scip-typescript: TypeScript, JavaScript
- rust-analyzer: Rust
- scip-clang: C++, C
- scip-ruby: Ruby
- scip-python: Python
- scip-dotnet: C#, Visual Basic
- scip-dart: Dart
- scip-php: PHP
For more details about indexers, including LSIF-based indexers, see the Sourcegraph documentation.
Other tools which use SCIP include the Sourcegraph CLI, and the SCIP CLI in this repo.
You can find binaries for the scip CLI tool here.
You can also compile a binary locally using:
git clone https://github.com/sourcegraph/scip.git --depth=1
cd scip
go build ./cmd/scipYou can consult the CLI reference or --help for usage information.
We welcome questions, suggestions as well as code and docs contributions.
For submitting contributions, check out Development.md to better understand project structure and common workflows.
Contributors should abide by the Sourcegraph Code of Conduct.
