A SCIP indexer for Apex source code. Generates SCIP index files that enable code navigation features like go-to-definition, find-references, and hover documentation in Sourcegraph and compatible editors.
Download the latest binary for your platform from the Releases page.
scip-apex index [source-dirs...] [flags]| Flag | Short | Default | Description |
|---|---|---|---|
--output |
-o |
index.scip |
Output file path |
--project-root |
current directory | Project root for relative paths | |
--namespace |
-n |
Default namespace for loaded code |
Index a standard Salesforce project:
scip-apex index force-app/main/default/classesIndex with a custom output path:
scip-apex index force-app/main/default/classes -o my-index.scipIndex with a namespace:
scip-apex index force-app/main/default/classes -n MyNamespace- Definitions: Classes, interfaces, enums, triggers, methods, fields, properties
- References: Type references, method calls, field accesses, constructor invocations
- Relationships: Implements and extends relationships between types
- Documentation: Doc comments attached to definitions
- Symbol kinds: Mapped to SCIP symbol kinds (Class, Interface, Enum, Method, Constructor, Field, Property, Parameter, Variable)
.cls- Apex classes, interfaces, and enums.trigger- Apex triggers
Inspect the generated index with the scip CLI:
go install github.com/sourcegraph/scip/cmd/scip@latest
scip print index.scip
scip snapshot --from index.scip