TruffleRuby is the GraalVM high-performance implementation of the Ruby programming language built by Oracle Labs.
There are three ways to install TruffleRuby releases and nightly builds:
-
Via GraalVM, which includes support for other languages such as JavaScript, R and Python and supports both the native and JVM configurations. Inside GraalVM will then be a
bin/rubycommand that runs TruffleRuby. We recommend that you use a Ruby manager to use TruffleRuby inside GraalVM. -
Via your Ruby manager/installer (RVM, rbenv, chruby, ruby-build, ruby-install). This contains only TruffleRuby, in the native configuration, making it a smaller download. It is meant for users just wanting a Ruby implementation and already using a Ruby manager.
-
Using the standalone distribution as a simple binary tarball. This distribution is also useful for testing TruffleRuby in CI. On TravisCI, you can simply use:
language: ruby rvm: - truffleruby
And on GitHub Actions:
- uses: ruby/setup-ruby@v1 with: ruby-version: truffleruby
You can use gem and bundle to install Gems as normal.
Please report any issue you might find on GitHub.
TruffleRuby aims to:
- Run idiomatic Ruby code faster
- Run Ruby code in parallel
- Boot Ruby applications in less time
- Execute C extensions in a managed environment
- Add fast and low-overhead interoperability with languages like Java, JavaScript, Python and R
- Provide new tooling such as debuggers and monitoring that work across languages
- All while maintaining very high compatibility with the standard implementation of Ruby
There are two main configurations of TruffleRuby: Native and JVM which make different trade-offs.
| Configuration: | Native (--native, default) |
JVM (--jvm) |
|---|---|---|
| Time to start TruffleRuby | about as fast as MRI startup | slower |
| Time to get to peak performance | faster | slower |
| Peak performance (also considering GC) | good | best |
| Java host interoperability | needs reflection configuration | just works |
To find out which configuration is used, run ruby --version on the command line
or check the value of RUBY_DESCRIPTION or TruffleRuby.native? in Ruby code.
Configurations are further detailed in Deploying TruffleRuby.
TruffleRuby is actively tested on these systems:
- Oracle Linux 7
- Ubuntu 18.04 LTS
- Ubuntu 16.04 LTS
- Fedora 28
- macOS 10.14 (Mojave)
- macOS 10.15 (Catalina)
You may find that TruffleRuby will not work if you severely restrict the
environment, for example by unmounting system filesystems such as /dev/shm.
- make and gcc for building C and C++ extensions.
- libssl for the
opensslC extension - zlib for the
zlibC extension
Without these dependencies, many libraries including RubyGems will not work. TruffleRuby will try to print a nice error message if a dependency is missing, but this can only be done on a best effort basis.
You may also need to set up a UTF-8 locale.
We recommend that people trying TruffleRuby on their gems and applications get in touch with us for help.
TruffleRuby is progressing fast but is currently probably not ready for you to try running your full Rails application on. However it is ready for experimentation and curious end-users to try on their gems and smaller applications, and to send us reports of issues they find.
TruffleRuby should in most cases work as a drop-in replacement for MRI, but you should read about our compatibility.
For many use cases TruffleRuby should work as a drop-in replacement for JRuby. However, our approach to integration with Java is different to JRuby so you should read our migration guide.
Extensive user documentation is available in doc/user.
See our source code repository and contributor documentation to contribute to TruffleRuby.
The best way to get in touch with us is to join the channel #truffleruby of the
GraalVM Slack.
You can also Tweet to @TruffleRuby, or email
[email protected].
Please report security vulnerabilities via the process outlined at reporting vulnerabilities guide, rather than by something public such as a GitHub issue or a Gitter conversation.
Announcements about GraalVM, including TruffleRuby, are made on the graal-dev mailing list.
The main authors of TruffleRuby ordered by first contribution are: Chris Seaton, Benoit Daloze, Kevin Menard, Petr Chalupa, Brandon Fish, Duncan MacGregor, Christian Wirth, Rafael França, Alan Wu, Nicolas Laurent.
See the security documentation.
TruffleRuby is copyright (c) 2013-2019 Oracle and/or its affiliates, and is made available to you under the terms of any one of the following three licenses:
- Eclipse Public License version 2.0, or
- GNU General Public License version 2, or
- GNU Lesser General Public License version 2.1.
See LICENCE.md, 3rd_party_licenses.txt and doc/legal/legal.md.
TruffleRuby is a fork of JRuby, combining it with code from the Rubinius project, and also containing code from the standard implementation of Ruby, MRI.