Skip to content

Installation

Most people are done in one click — see the install section of getting started. This page is for everything else.

The ry extension bundles the binary for Linux x86_64, macOS aarch64, and Windows x86_64.

On any other architecture the extension installs but has no binary to run. Install the CLI separately and point the extension at it:

settings.json
{
"ry.path": "/absolute/path/to/ry"
}

Every extension setting is listed under editor settings.

Not in Zed’s extension registry yet. Until it is, install it from the repository as a dev extension:

  1. Install a Rust toolchain — Zed compiles dev extensions to WebAssembly itself.
  2. Clone the repository.
  3. Run zed: install dev extension from the command palette and select the editors/zed directory.

Zed has no built-in R support, so install the R extension first. Full instructions, including how the extension finds the binary, are in editors/zed.

Prebuilt binary. Download from Releases. Assets are named by Rust target triple and each archive holds a single ry binary:

PlatformAsset
Linux x86_64ry-x86_64-unknown-linux-gnu.tar.gz
macOS aarch64ry-aarch64-apple-darwin.tar.gz
Windows x86_64ry-x86_64-pc-windows-gnu.zip
Terminal window
curl -sSL https://github.com/felix-andreas/ry/releases/download/0.3.0-alpha/ry-x86_64-unknown-linux-gnu.tar.gz | tar xz
sudo mv ry /usr/local/bin/

Name the tag explicitly. Every release so far is marked a pre-release, so releases/latest/ resolves to an older stable tag rather than the newest build.

From source, if you have a Rust toolchain:

Terminal window
cargo install --git https://github.com/felix-andreas/ry ry-lang

The package is ry-lang because the name ry was already taken on crates.io; the binary it installs is ry.

This is also the route for architectures without a prebuilt binary.

Planned: a one-line installer, so neither a manual download nor a Rust toolchain is needed. No date.

RStudio has no language-server integration, but it can use ry as its external formatter:

  1. Tools → Global Options → Code → Formatting → Format with an External Tool, and set the reformat command to path/to/ry fmt.
  2. For format-on-save, Tools → Global Options → Code → Saving and tick Reformat documents on save.

Type checking and code analysis are not available inside RStudio. Run ry check in a terminal, or in CI.

Terminal window
ry --version

Then run it on a project — getting started shows what a first run looks like.