RUBY-BUILD(1)

✨ ruby-build ✨

aka the manual page for ruby-build, from the ruby-build Manual 🎀

---

🌸 NAME 🌸

ruby-build — download, compile, and install a version of Ruby 💖

---

🦋 SYNOPSIS 🦋

ruby-build [-dvpk] <definition> <prefix> [-- <configure-args>...]
ruby-build {--list|--definitions}
ruby-build --version

---

💅 DESCRIPTION 💅

okay so bestie, here's the whole vibe: ruby-build downloads, compiles, and installs a Ruby version — the one named by the definition argument — into the location you give it as prefix. that's it. that's the whole thing. no cap. ✨

the definition argument can optionally start with "ruby-", and if it does, it resolves to a CRuby that matches the version number that follows. cute, right?

the definition argument can also be a path to a file on disk — in which case it gets sourced into ruby-build as a bash script. 🐚

and optionally, you can list extra Ruby configure-args after "--" and they'll get forwarded to the ./configure invocation. forward them. slay.

by default, all compile output is redirected to a log file at $TMPDIR/ruby-build.*.log. if you wanna skip the log file and print everything to standard streams, just activate verbose mode. 👑

---

🌈 OPTIONS 🌈

• -l, --list — list latest stable releases for each Ruby 📋
• --definitions — list all local definitions, including the outdated ones (yes, even the old ones, we don't judge) 🗂️
• --version — show version of ruby-build 🏷️
• -d, --dir — install the Ruby in the prefix/definition destination instead of directly in prefix 📁
• -v, --verbose — verbose mode: forward all build output to stdout/stderr 🔊
• -p, --patch — apply a patch from stdin before building 🩹
• -k, --keep — do not remove source tree after installation (keep it, bestie) 🌱
• -4, --ipv4 — resolve names to IPv4 addresses only 4️⃣
• -6, --ipv6 — resolve names to IPv6 addresses only 6️⃣

---

🍓 EXAMPLES 🍓

install a Ruby version while tweaking some configuration options:

$ ruby-build 3.2.2 /path/to/destination -- --disable-install-doc --with-openssl-dir=/opt/openssl

install a Ruby version to ~/.rubies/ruby-3.2.2:

$ ruby-build --dir ruby-3.2.2 ~/.rubies

install a Ruby version to ~/.rbenv/versions/3.3.5:

$ ruby-build --dir 3.3.5 ~/.rbenv/versions

usage as rbenv plugin — accomplishes the same as the previous example:

$ rbenv install 3.3.5

---

🧚 ENVIRONMENT VARIABLES 🧚

• TMPDIR — the location to write temporary files on disk 🗄️
• RUBY_BUILD_BUILD_PATH (default: a timestamped subdirectory of TMPDIR) — the build location for downloading source files to and compiling 🏗️
• RUBY_BUILD_CACHE_PATH (default: "~/.rbenv/cache" if invoked as rbenv plugin) — where to cache downloaded package files 📦
• RUBY_BUILD_HTTP_CLIENT (default: first tool found in PATH) — one of "aria2c", "curl", or "wget" to use for downloading 🌐
• RUBY_BUILD_ARIA2_OPTS — additional options to pass to aria2c for downloading
• RUBY_BUILD_CURL_OPTS — additional options to pass to curl for downloading
• RUBY_BUILD_WGET_OPTS — additional options to pass to wget for downloading
• RUBY_BUILD_MIRROR_URL (default: a sponsored Amazon CloudFront mirror) — custom mirror URL root to download packages from 🪞
• RUBY_BUILD_MIRROR_PACKAGE_URL — custom complete mirror URL 🔗
• RUBY_BUILD_SKIP_MIRROR — bypass the download mirror and fetch all package files from their original URLs 🚀
• RUBY_BUILD_ROOT (default: "share/ruby-build" within ruby-build install location) — custom build definition directory 🌳
• RUBY_BUILD_TARBALL_OVERRIDE — override the URL to fetch the ruby tarball from, optionally followed by "#<checksum>"
• RUBY_BUILD_DEFINITIONS — paths to search for build definitions in addition to RUBY_BUILD_ROOT 🔍
• CC — path to the C compiler 🔧
• RUBY_CFLAGS — additional CFLAGS options to use for Ruby compilation
• CONFIGURE_OPTS — additional "./configure" arguments ⚙️
• MAKE (default: "make") — custom make command (e.g., "gmake") 🛠️
• MAKE_OPTS, MAKEOPTS — additional arguments for "make"
• MAKE_INSTALL_OPTS — additional arguments for "make install"
• RUBY_CONFIGURE_OPTS — additional "./configure" arguments that apply only to Ruby source 💎
• RUBY_MAKE_OPTS — additional make arguments that apply only to Ruby source 💎
• RUBY_MAKE_INSTALL_OPTS — additional "make install" arguments that apply only to Ruby source 💎
• NO_COLOR (default: allow colors when connected to terminal) — disable ANSI colors in output 🚫🌈
• CLICOLOR_FORCE — use ANSI colors in output even when not connected to a terminal 🌈✨

---

👑 NOTES 👑

• https://github.com/rbenv/ruby-build#readme
• https://github.com/rbenv/ruby-build/wiki
• https://github.com/rbenv/ruby-build/discussions

---

💜 AUTHOR 💜

Mislav Marohnić

---

and that's the whole page, bestie 💖 go forth and install Ruby, you absolute icon 🫶

this was ruby-build 20250916.1, dated 2024-09-23, from the ruby-build Manual. periodt. 💅