SCIP indexer for TypeScript, JavaScript, and Svelte.

npm install -g @sourcegraph/scip-typescript

Currently, Node v22 and Node v24 are supported.

Navigate to the project root, containing tsconfig.json.

npm install # or yarn install
scip-typescript index

Navigate to the project root, containing package.json.

npm install # or yarn install
scip-typescript index --infer-tsconfig

To improve the quality of indexing results for JavaScript, consider adding @types/* packages as devDependencies in package.json.

Install the project dependencies and run the indexer from the directory that contains the project's tsconfig.json or jsconfig.json. SvelteKit projects should run svelte-kit sync first so their generated configuration is current.

npm install # or yarn/pnpm install
npx svelte-kit sync # SvelteKit projects only
scip-typescript index

Navigate to the project root, containing package.json.

yarn install

scip-typescript index --yarn-workspaces

Navigate to the project root, containing package.json.

pnpm install

scip-typescript index --pnpm-workspaces

Add the following run steps to your CI pipeline:

npm install -g @sourcegraph/scip-typescript @sourcegraph/src
npm install # or yarn install
scip-typescript index
# Upload index with any necessary tokens (shown here using GitHub workflow syntax)
src code-intel upload -github-token='${{ secrets.GITHUB_TOKEN }}' -no-progress

For more examples, see the Sourcegraph docs.

If scip-typescript index is not showing progress, try running it again with the --progress-bar flag. The progress bar prints out the current file being indexed that could reveal details why progress is stalling. The progress bar is disabled by default because it prints out a lot of noise in CI logs, and the most common environment to run scip-typescript is in CI.

You may experience OOM issues when indexing large codebases

<--- JS stacktrace --->

FATAL ERROR: Reached heap limit Allocation failed - JavaScript heap out of memory
 1: 0xb7b150 node::Abort() [node]
 2: 0xa8c89a  [node]
 3: 0xd62ea0 v8::Utils::ReportOOMFailure(v8::internal::Isolate*, char const*, bool) [node]
 4: 0xd63247 v8::internal::V8::FatalProcessOutOfMemory(v8::internal::Isolate*, char const*, bool) [node]
 5: 0xf40945  [node]
 6: 0xf52e2d v8::internal::Heap::CollectGarbage(v8::internal::AllocationSpace, v8::internal::GarbageCollectionReason, v8::GCCallbackFlags) [node]
 ...

To fix this problem, try one of the following steps:

• Add --no-global-caches to the index command like this scip-typescript index --no-global-caches REST_OF_THE_COMMAND. By default, scip-typescript caches symbol indexing across TypeScript projects to speed up indexing. This cache increases the memory footprint, which can cause OOM. Disabling this cache slows down indexing but reduces the memory footprint.
• Increase memory to the Node.js process by running scip-typescript like this node --max-old-space-size=16000 "$(which scip-typescript)" index REST_OF_COMMAND. Replace 16000 with an even larger number if your computer has bigger RAM.

See Development.md for docs on how to work on this project.

Contributors should follow the Sourcegraph Community Code of Conduct.