# scip-ruby

**Repository Path**: mirrors_sourcegraph/scip-ruby

## Basic Information

- **Project Name**: scip-ruby
- **Description**: A SCIP indexer for Ruby, powered by Sorbet
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: scip-ruby/master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-06-16
- **Last Updated**: 2025-12-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# scip-ruby

Experimental [SCIP](https://github.com/sourcegraph/scip) indexer for Ruby,
enabling precise code navigation for Ruby —
Go to definition, Find references, hover docs etc. –
in Sourcegraph.

![Example showing cross-file Find references for a type from the shopify-api-ruby codebase](https://user-images.githubusercontent.com/93103176/194205214-2e2d64da-d02c-4ab3-8636-2497e4d46628.png)

If you have any questions, bug reports, feature requests or feedback,
please [file an issue](https://github.com/sourcegraph/scip-ruby/issues/new/choose).
The most common indexing workflows are discussed below;
you can also consult the [CLI reference docs](docs/scip-ruby/CLI.md)
for more information.

## Supported Configurations

scip-ruby builds on top of
the [Sorbet](https://github.com/sorbet/sorbet) type-checker.
It is primarily meant for use in projects which have started adopting Sorbet.
Higher Sorbet adoption (`# typed: true` or higher) is likely to lead to
a better code navigation experience.
However, scip-ruby can also index `# typed: false` files on a best-effort basis.
Like Sorbet, scip-ruby treats files without a `# typed:` sigil
as implicitly being `# typed: false`.

Currently, we have gems and binaries available for x86\_64 Linux and arm64 macOS.
<!-- Keep list of platforms in sync with .github/workflows/release.yml -->

## Quick Start

This section covers the easiest way to use `scip-ruby`: as a gem,
which includes a platform-specific `scip-ruby` binary
and uses that for indexing.
Alternately, you can
[directly download a binary and index your code](#download-binary-and-index).

### First-time setup

If you have a `.gemspec` file, use `add_development_dependency`:

```ruby
Gem::Specification.new do |spec|
  # ... other stuff ...
  spec.add_development_dependency("scip-ruby")
end
```

Otherwise, add this line to your `Gemfile`:

```ruby
gem 'scip-ruby', require: false, :group => :development
```

After either of those steps, run `bundle install`
to download and install fetch `scip-ruby`.

### Generate an index

Run `scip-ruby` along with some information about your gem.

- If you have a `sorbet/config` file, that will be picked up
  automatically to determine which files to index.
    ```bash
    bundle exec scip-ruby
    ```
- If you don't have a `sorbet/config` file, add an extra path argument
  to index all files in the project.
    ```bash
    bundle exec scip-ruby .
    ```

These commands will output a SCIP index to `index.scip`.
Any other needed information will be inferred from directory layout.
For customizing how `scip-ruby` interprets your configuration,
see the [CLI reference](docs/scip-ruby/CLI.md).

The SCIP index can be uploaded to a Sourcegraph instance
using the [Sourcegraph CLI](https://github.com/sourcegraph/src-cli)'s
[upload command](https://docs.sourcegraph.com/cli/references/code-intel/upload).

If you're curious about the internals of the index,
such as which files were indexed,
check out the [SCIP CLI](https://github.com/sourcegraph/scip/blob/main/docs/CLI.md)
and the [SCIP development docs](https://github.com/sourcegraph/scip/blob/main/Development.md#debugging).

## Download binary and index

You can download a
[release binary](https://github.com/sourcegraph/scip-ruby/releases)
and run it directly, similar to invoking Sorbet.

<!-- Keep command below in sync with release-template.md -->
```bash
ARCH="$(uname -m)" \
OS="$(uname -s | tr '[:upper:]' '[:lower:]')" \
bash -c 'curl -L "https://github.com/sourcegraph/scip-ruby/releases/latest/download/scip-ruby-$ARCH-$OS" -o scip-ruby' && \
chmod +x scip-ruby

# If using in CI with 'set -e', make sure to wrap the
# scip-ruby invocation in 'set +e' followed by 'set -e'
# so that indexing failures are non-blocking.
./scip-ruby
```

The generated index can be uploaded to a Sourcegraph instance
using the [Sourcegraph CLI](https://github.com/sourcegraph/src-cli) (v3.43.0 or newer).
Typically, the command looks like:

```bash
SRC_ACCESS_TOKEN="your token" SRC_ENDPOINT="url for Sourcegraph instance" src code-intel upload -file=/path/to/index.scip
```

For more details, see the Sourcegraph CLI docs.

## Building from source for indexing

See the [Contributing docs](./docs/scip-ruby/CONTRIBUTING.md)
for build instructions.
Once the `scip-ruby` binary is built, you can index it as described above.

## Contributing

See the [Contributing docs](./docs/scip-ruby/CONTRIBUTING.md).