Install solargraph with Homebrew

Project links

• Homepage
• Repository

Commands and aliases

• solargraph

Project history

The castwide/solargraph GitHub repository was created in March 2017, and RubyGems records version 0.1.0 on 2017-03-18. The gem was described early as IDE tools for code analysis and autocompletion, while the current README frames it as a Ruby language server.

Solargraph grew with the Language Server Protocol era. The README lists Visual Studio Code, Sublime Text, Vim and Neovim, Emacs, and Eclipse integrations, and the guide site describes editor integration as requiring a language client.

The project later expanded beyond autocomplete into diagnostics, inline documentation, type checking, YARD and RBS-aware code maps, Bundler-aware gem support, plugin support, and a separate documentation cache.

Adoption history

RubyGems is Solargraph's primary distribution channel, with the official gem metadata pointing to solargraph.org and the GitHub source. Homebrew and Nix packages make the same CLI available to users who prefer system package managers over gem install.

Editor integration drove adoption: the official README calls the VS Code extension out directly and lists third-party integrations for several common editors, making solargraph a common bridge between Ruby projects and LSP-capable editors.

How it is used

Developers install the solargraph command, generate or maintain project configuration with bundle exec solargraph config, and run the server through editor integrations using stdio or TCP socket modes.

Project-local configuration lives in .solargraph.yml at the repository root, with optional global configuration at ~/.config/solargraph/config.yml. The README also documents a cache directory at ~/.cache/solargraph and Bundler-aware usage with bundle exec solargraph socket or stdio.

Why package nerds care

Solargraph matters to package nerds because it turns Ruby's dynamic runtime, gems, YARD docs, RBS signatures, Bundler context, and editor protocols into one packaged CLI service.

It also illustrates a packaging split familiar to language ecosystems: the upstream artifact is a Ruby gem, but system package managers package it so editors and shell environments can depend on a stable solargraph executable.

Timeline

• 2017-03: GitHub repository and RubyGems 0.1.0 release appear.
• 2017-2020s: Solargraph becomes a Ruby LSP server integrated by VS Code and other editors.
• 2019: Version 0.33.0 adds type-checking functionality, according to the README.
• 2026: RubyGems lists Solargraph 0.60.2 with Ruby 3.1+ requirements and current source metadata.

Related projects

• Language Server Protocol: the editor integration protocol Solargraph targets.
• YARD and RBS: documentation and type-information sources Solargraph uses for code maps.
• Bundler: important for running Solargraph in the same dependency context as a Ruby project.
• vscode-solargraph, nvim-lspconfig, coc-solargraph, eglot, and lsp-mode: editor integration paths listed by the upstream README.

Sources

• current_curation.config-file-location
• https://api.github.com/repos/castwide/solargraph
• https://github.com/castwide/solargraph#readme
• https://rubygems.org/api/v1/gems/solargraph.json
• https://rubygems.org/api/v1/versions/solargraph.json
• https://solargraph.org/guides/getting-started
• source_facts.package-manager