README.Rmd

---
output:
  github_document:
    includes:
      before_body: tools/header.md
---

```{r, include = FALSE}
knitr::opts_chunk$set(
  comment = "#>",
  out.width = "100%"
)
```

* 🚀&nbsp; <a href="#id-features">Features</a>
* 🐞&nbsp; <a href="#id-known-issues">Known Issues</a>
* ⬇️&nbsp;  <a href="#id-installation">Installing rig</a>
* ⚙️&nbsp;  <a href="#id-usage">Usage</a>
* ⛵&nbsp; <a href="#id-macos-menu-bar-app">macOS menu bar app</a>
* 📦&nbsp; <a href="#id-container">Docker containers with rig</a>
* 🤝&nbsp; <a href="#id-feedback">Feedback</a>
* ❓&nbsp; <a href="#id-faq">FAQ</a>
* 📘&nbsp; <a href="#id-license">License</a>

## 🚀&nbsp; Features <a id="id-features">

* Works on macOS, Windows and Linux.
* Supports many Linux distributions, see
  [list below](#supported-linux-distributions).
* Easy installation and update, no system requirements on any platform.
* Install multiple R versions.
* Select the default R version, for the terminal and RStudio.
* Select R version to install using symbolic names: `devel`, `next`,
  `release`, `oldrel`, etc.
* List R versions available to install.
* Run multiple versions _at the same_ time using quick links.
  E.g. `R-4.1` or `R-4.1.2` starts R 4.1.x. Quick links are automatically
  added to the user's path.
* On macOS it comes with a menu bar app that shows the default R
  version and lets to select it interactively.
  [See below](#id-macos-menu-bar-app).
* On arm64 macs select between x86_64 and arm64 versions or R, or install both.
* Sets up the default CRAN mirror and [PPM](https://packagemanager.posit.co/).
* Installs [pak](https://pak.r-lib.org) and set up automatic
  [system requirements installation](https://pak.r-lib.org/dev/reference/sysreqs.html).
* Creates and configures user level package libraries.
* Restricts permissions to the system library.
  (On macOS, not needed on Windows and Linux).
* Includes auto-complete for `zsh` and `bash`, on macOS and Linux.
* Updates R installations to allow debugging with `lldb`, and to allow
  core dumps, on macOS.
* Installs the appropriate Rtools versions on Windows and sets them up.
* Cleans up stale R-related entries from the Windows registry.
* Switches to root/administrator user as needed.
* Supports JSON output for scripting.

## 🐞&nbsp; Known Issues <a id="id-known-issues">

* On macOS, R.app often does not work if you install multiple R versions.

Found another issue? Please report it in our
[issue tracker](https://github.com/r-lib/rig/issues).

## ⬇️&nbsp; Installing rig <a id="id-installation">

* [macOS (x86_64 or arm64)](#id-macos)
  * [Installer](#id-macos-installer)
  * [Homebrew](#id-macos-homebrew)
* [Windows](#id-windows)
  * [Installer](#id-windows-installer)
  * [Scoop](#id-windows-scoop)
  * [Chocolatey](#id-windows-chocolatey)
  * [Winget](#id-windows-winget)
* [Linux](#id-linux)
  * [Supported Linux distributions](#id-supported-linux-distributions)
  * [Ubuntu and Debian (DEB package)](#id-ubuntu-and-debian-deb-package)
  * [RHEL, Fedora, Rocky Linux, Almalinux, etc. (RPM package)](#id-rhel-fedora-rocky-linux-almalinux-etc-rpm-package)
  * [OpenSUSE and SLES (RPM package)](#id-opensuse-and-sles-rpm-package)
  * [Tarball on any supported distro](#id-linux-targz)
* [Auto-complete](#id-auto-complete)

### Installing rig on macOS <a id="id-macos">

You can one of our installers or our Homebrew tap.

#### Installing rig on macOS (installer) <a id="id-macos-installer">

Download the latest release from https://github.com/r-lib/rig/releases
and install it the usual way.

#### Installing rig on macOS (Homebrew) <a id="id-macos-homebrew">

If you use Homebrew (Intel or Arm version), you can install rig from our
tap:

```sh
brew tap r-lib/rig
brew install --cask rig
```

You can use x86_64 rig on Arm macs, and it will be able to install Arm
builds of R. But you cannot use Arm rig on Intel macs. If you use both brew
versions, only install rig with one of them.

To update rig you can run

```sh
brew upgrade --cask rig
```

### Installing rig on Windows <a id="id-windows">

There are several possible ways to install rig on Windows: with our
installer, `scoop`, `choco` or `winget`.

#### Installing rig on Windows (installer) <a id="id-windows-installer">

Download the latest release from https://github.com/r-lib/rig/releases
and install it the usual way.

`rig` adds itself to the user's path, but you might need to restart your
terminal after the installation on Windows.

#### Installing rig on Windows (Scoop) <a id="id-windows-scoop">

If you use [Scoop](https://scoop.sh/), you can install rig from the scoop
bucket at
[`cderv/r-bucket`](https://github.com/cderv/r-bucket#r-installation-manager-rig):

``` powershell
scoop bucket add r-bucket https://github.com/cderv/r-bucket.git
scoop install rig
```

To update run

``` powershell
scoop update rig
```

#### Installing rig on Windows (Chocolatey) <a id="id-windows-chocolatey">

If you use [Chocolatey](https://chocolatey.org/) (e.g. on GitHub
Actions) you can install `rig` with

``` powershell
choco install rig
```

and upgrade to the latest version with

``` powershell
choco upgrade rig
```

#### Installing rig on Windows (WinGet) <a id="id-windows-winget">

An easy way to install rig on Windows 10 and above is to use the
built-in WinGet package manager. The name of the package is `posit.rig`.
```
winget install posit.rig
```

Note that updating a WinGet package typically takes some time, so 
WinGet might not have the latest version of rig.

### Installing rig on Linux <a id="id-linux">

On Linux you can install rig from a DEB or RPM package, or from a tarball.

#### Supported Linux distributions <a id="id-supported-linux-distributions">

- Debian 10, 11, 12,
- Ubuntu 20.04, 22.04, 24.04
- Fedora Linux 39, 40, 41
- OpenSUSE 15.5, 15.6
- SUSE Linux Enterprise 15 SP5, 15 SP6
- Red Hat Enterprise Linux 7, 8, 9,
- AlmaLinux 8, 9,
- Rocky Linux 8, 9.

We use the R builds from the Posit
[R-builds project](https://github.com/rstudio/r-builds#r-builds).


#### Installing rig on Ubuntu and Debian (DEB package) <a id="id-ubuntu-and-debian-deb-package">

On any Ubuntu or Debian distro, you can use our package repository to
install rig. First you add our key to your config:
```
`which sudo` curl -L https://rig.r-pkg.org/deb/rig.gpg -o /etc/apt/trusted.gpg.d/rig.gpg
```

Then add the rig repository:
```
`which sudo` sh -c 'echo "deb http://rig.r-pkg.org/deb rig main" > /etc/apt/sources.list.d/rig.list'
```

If you already added both the key and the repository, then install the `r-rig`
package (`rig` is a different package in Debian and Ubuntu):
```
`which sudo` apt update
`which sudo` apt install r-rig
```

#### Installing rig on RHEL, Fedora, Rocky Linux, Almalinux, etc. (RPM package) <a id="id-rhel-fedora-rocky-linux-almalinux-etc-rpm-package">

On most RPM based distros (except for OpenSUSE and SLES) you can install
our RPM package directly:

```
`which sudo` yum install -y https://github.com/r-lib/rig/releases/download/latest/r-rig-latest-1.$(arch).rpm
```

#### Installing rig on OpenSUSE and SLES (RPM package) <a id="id-opensuse-and-sles-rpm-package">

On OpenSUSE and SLES use `zypper` instead of `yum`:

```
`which sudo` zypper install -y --allow-unsigned-rpm https://github.com/r-lib/rig/releases/download/latest/r-rig-latest-1.$(arch).rpm
```

#### Installing rig on any Linux distribution (tarball) <a id="id-linux-targz">

Download the latest releast from https://github.com/r-lib/rig/releases
and uncompress it to `/usr/local`

```
curl -Ls https://github.com/r-lib/rig/releases/download/latest/rig-linux-$(arch)-latest.tar.gz |
  `which sudo` tar xz -C /usr/local
```

### Installing auto-complete on macOS and Linux <a id="id-auto-complete">

The macOS and Linux installers also install completion files for `zsh`
and `bash`.

`zsh` completions work out of the box.

For `bash` completions install the `bash-completion` package from Homebrew
or your Linux distribution and make sure it is loaded from your `.bashrc`.
(You don't need to install `bash` from Homebrew, but you can if you like.)

## ⚙️&nbsp; Usage <a id="id-usage">

Use `rig add` to add a new R installation:

```
rig add release
```

Use `rig list` to list the currently installed R versions, and `rig default`
to set the default one.

Run `rig` to see all commands and examples.

Run `rig --help` and `rig <subcommand> --help` to see the documentation.

### Command list:

```
rig add        -- install a new R version [alias: install]
rig available  -- List R versions available to install.
rig default    -- print or set default R version [alias: switch]
rig library    -- manage package libraries [alias: lib] (experimental)
rig list       -- list installed R versions [alias: ls]
rig resolve    -- resolve a symbolic R version
rig rm         -- remove R versions [aliases: del, delete, remove]
rig rstudio    -- start RStudio with the specified R version
rig run        -- Run R, an R script or an R project
rig sysreqs    -- manage R-related system libraries and tools (experimental) (macOS)
rig system     -- manage current installations
```

Run `rig <subcommand> --help` for information about a subcommand.


### macOS `rig system` subcommands

```
rig system add-pak                 -- install or update pak for an R version
rig system allow-debugger          -- allow debugging R with lldb and gdb
rig system allow-debugger-rstudio  -- allow debugging RStudio with lldb and gdb
rig system allow-core-dumps        -- allow creating core dumps when R crashes
rig system fix-permissions         -- restrict system library permissions to admin
rig system forget                  -- make system forget about R installations
rig system make-links              -- create R-* quick links
rig system make-orthogonal         -- make installed versions orthogonal
rig system no-openmp               -- remove OpenMP (-fopenmp) option for Apple compilers
rig system setup-user-lib          -- set up automatic user package libraries [alias: create-lib]
```

### Windows `rig system` subcommands

```
rig system add-pak                 -- install or update pak for an R version
rig system clean-registry          -- clean stale R related entries in the registry
rig system make-links              -- create R-* quick links
rig system rtools                  -- manage Rtools installations
rig system setup-user-lib          -- set up automatic user package libraries [alias: create-lib]
rig system update-rtools40         -- update Rtools40 MSYS2 packages
```

### Linux `rig system` subcommands

```
rig system detect-platform         -- detect operating system version and distribution
rig system add-pak                 -- install or update pak for an R version
rig system make-links              -- create R-* quick links
rig system setup-user-lib          -- set up automatic user package libraries [alias: create-lib]
```

## ⛵&nbsp; macOS menu bar app <a id="id-macos-menu-bar-app">

View and select the default R version in the macOS menu bar.
Start RStudio or a recent RStudio project with the selected R version.
Select between your package libraries.

To start the menu bar app the first time, run the Rig app in
"Applications" from Finder or Spotlight, or run
```
open -a Rig
```
from a Terminal. Then you can check the "Launch at login" box in
"Preferences" to start it automatically in the future.

<img src="tools/rig-app.png">

Note: if you have a lot of menu bar apps running on an M1/M2 mac, then
the some of them might be under the camera area. There is no good solution
for this currently, other than running less menu bar apps.

## 📦&nbsp; Docker containers with rig (and multiple R versions) <a id="id-container">

Use the `ghcr.io/r-lib/rig/r` Docker container to easily run multiple
R versions.
It is currently based on Ubuntu 22.04 and contains rig and the six latest
R versions, including R-next and R-devel.
It is available for x86_64 and arm64 systems:

```
> docker run ghcr.io/r-lib/rig/r rig ls
* name   version    aliases
------------------------------------------
  3.6.3
  4.0.5
  4.1.3
  4.2.3             oldrel
* 4.3.1             release
  devel  (R 4.4.0)
  next   (R 4.3.1)
```

See this image on
[GitHub](https://github.com/r-lib/rig/pkgs/container/rig%2Fr).

### All containers

We also have other containers with rig and either R-devel and R-release
preinstalled, on various Linux distros.
Here is a table of all containers:

Name                                      | OS                 | R version      | Tags
------------------------------------------+--------------------+----------------+------------------------------------------------------------------------------------------------
`ghcr.io/r-lib/rig/ubuntu-22.04-multi`    | Ubuntu 22.04       | last 6 (daily) | `r`, `rig`, `multi`, `ubuntu-multi`
`ghcr.io/r-lib/rig/ubuntu-24.04-release`  | Ubuntu 24.04       | release        | `ubuntu-24.04`
`ghcr.io/r-lib/rig/ubuntu-24.04-devel`    | Ubuntu 24.04       | devel (daily)  |
`ghcr.io/r-lib/rig/ubuntu-22.04-release`  | Ubuntu 22.04       | release        | `release`, `ubuntu`, `ubuntu-release`, `ubuntu-latest`, `ubuntu-latest-release`, `ubuntu-22.04`
`ghcr.io/r-lib/rig/ubuntu-22.04-devel`    | Ubuntu 22.04       | devel (daily)  | `devel`, `ubuntu-devel`, `ubuntu-latest-devel`
`ghcr.io/r-lib/rig/ubuntu-20.04-release`  | Ubuntu 20.04       | release        | `ubuntu-20.04`
`ghcr.io/r-lib/rig/ubuntu-20.04-devel`    | Ubuntu 20.04       | devel (daily)  |
`ghcr.io/r-lib/rig/debian-12-release`     | Debian 12          | release        | `debian`, `debian-release`, `debian-latest`, `debian-latest-release`, `debian-12`
`ghcr.io/r-lib/rig/debian-12-devel`       | Debian 12          | devel (daily)  | `debian-devel`, `debian-latest-devel`
`ghcr.io/r-lib/rig/debian-11-release`     | Debian 11          | release        | `debian-11`
`ghcr.io/r-lib/rig/debian-11-devel`       | Debian 11          | devel (daily)  |
`ghcr.io/r-lib/rig/debian-10-release`     | Debian 10          | release        | `debian-10`
`ghcr.io/r-lib/rig/debian-10-devel`       | Debian 10          | devel (daily)  |
`ghcr.io/r-lib/rig/fedora-40-release`     | Fedora 40          | release        | `fedora`, `fedora-release`, `fedora-latest`, `fedora-latest-release`, `fedora-40`
`ghcr.io/r-lib/rig/fedora-40-devel`       | Fedora 40          | devel          | `fedora-devel`, `fedora-latest-devel`
`ghcr.io/r-lib/rig/fedora-39-release`     | Fedora 39          | release        | `fedora-39`
`ghcr.io/r-lib/rig/fedora-39-devel`       | Fedora 39          | devel          |
`ghcr.io/r-lib/rig/opensuse-15.5-release` | OpenSUSE Leap 15.5 | release        | `opensuse`, `opensuse-release`, `opensuse-latest`, `opensuse-latest-release`, `opensuse-15.5`
`ghcr.io/r-lib/rig/opensuse-15.5-devel`   | OpenSUSE Leap 15.5 | devel (daily)  | `opensuse-devel`, `opensuse-latest-devel`

For convenience, we also create these tags:

Tag                                | Image                   | Description
-----------------------------------+-------------------------+------------------------------------
`ghcr.io/r-lib/rig/r`              | `ubuntu-22.04-multi`    | Last 6 R versions on latest Ubuntu.
`ghcr.io/r-lib/rig/rig`            | "                       | "
`ghcr.io/r-lib/rig/multi`          | "                       | "
`ghcr.io/r-lib/rig/ubuntu-multi`   | "                       | "
`ghcr.io/r-lib/rig/release`        | `ubuntu-22.04-release`  | Latest R release.
`ghcr.io/r-lib/rig/ubuntu`         | `ubuntu-22.04-release`  | Latest R release on latest Ubuntu.
`ghcr.io/r-lib/rig/ubuntu-22.04`   | `ubuntu-22.04-release`  | Latest R release on Ubuntu 22.04.
`ghcr.io/r-lib/rig/devel`          | `ubuntu-22.04-devel`    | R devel.
`ghcr.io/r-lib/rig/ubuntu-devel`   | `ubuntu-22.04-devel`    | R devel on latest Ubuntu.
`ghcr.io/r-lib/rig/ubuntu-24.04`   | `ubuntu-24.04-release`  | Latest R release on Ubuntu 24.04.
`ghcr.io/r-lib/rig/ubuntu-20.04`   | `ubuntu-20.04-release`  | Latest R release on Ubuntu 20.04.
`ghcr.io/r-lib/rig/debian`         | `debian-12-release`     | Latest R release on latest Debian.
`ghcr.io/r-lib/rig/debian-12`      | `debian-12-release`     | Latest R release on Debian 12.
`ghcr.io/r-lib/rig/debian-devel`   | `debian-12-devel`       | R devel on latest Debian.
`ghcr.io/r-lib/rig/debian-11`      | `debian-11-release`     | Latest R release on Debian 11.
`ghcr.io/r-lib/rig/debian-10`      | `debian-10-release`     | Latest R release on Debian 10.
`ghcr.io/r-lib/rig/fedora`         | `fedora-40-release`     | Latest R release on latest Fedora.
`ghcr.io/r-lib/rig/fedora-40`      | `fedora-40-release`     | Latest R release on Fedora 40.
`ghcr.io/r-lib/rig/fedora-devel`   | `fedora-40-devel`       | R devel on latest Fedora.
`ghcr.io/r-lib/rig/fedora-39`      | `fedora-39-release`     | Latest R release on Fedora 39.
`ghcr.io/r-lib/rig/opensuse`       | `opensuse-15.5-release` | Latest R release on latest OpenSUSE.
`ghcr.io/r-lib/rig/opensuse-15.5`  | `opensuse-15.5-release` | Latest R release on OpenSUSE 15.5.
`ghcr.io/r-lib/rig/opensuse-devel` | `opensuse-15.5-devel`   | R devel on latest OpenSUSE.

See all container images on
[GitHub](https://github.com/orgs/r-lib/packages?repo_name=rig).

### Docker container features:

For all containers:

* rig is pre-installed, so you can easily add or remove R versions.
* https://github.com/r-lib/pak is installed for all R versions.
* Automatic system dependency installation via pak.
* Linux binary packages are automatically installed from the
  [Posit Public Package Manager](https://packagemanager.posit.co/client/#/)
  in x86_64 containers, on Ubuntu, Debian and OpenSUSE.
* Available on x86_64 and aarch64.

## 🤝&nbsp; Feedback <a id="id-feedback">

Please open an issue in our issue tracker at
https://github.com/r-lib/rig/issues

```{r child="tools/faq.Rmd"}
```

## 📘 &nbsp; License <a id="id-license">

MIT 2021-2024 © Posit Software, PBC.